PCGen Code Exploration Almanac - Revision history

James at 00:29, 3 November 2013

2013-11-03T00:29:27Z

James: Add Creating a New Lst Token section plus tools

2013-11-03T00:26:17Z

Add Creating a New Lst Token section plus tools

James: Initial page

2013-10-18T12:17:26Z

Initial page

New page

{| align="right"
| __TOC__
|}

=Introduction=
This guide is a collection of strategies and ways to tackle tasks in the PCGen code. It doesn’t try to be an architectural guide, for that I would start with [[Explanation_of_the_Code_Base]] , which is a good document to be familiar with. There is also some good info at [[Architecture]]

=Lst Tokens as an Entry Point=
Quite often you will know the data that is associated with a problem or request. An important tip to remember is that almost all LST tokens are processed by a class which starts with the same name. e.g. the kit EQUIPBUY token is processed by the class plugin.lsttokens.kit.startpack.EquipBuyToken

All token classes then have a parse and unparsed method (sometimes it is in a parent class). You can look at these to find out how the token is interpreted and where the value is stored. Generally the token value is stored in a map in the rules object with a specific constant as a key (e.g. Objectkey.EQUIP_BUY). You can use this key to trace where the token value is processed, thus quickly getting to the code you want to look at.

So, typically in Eclipse I will
# Search for a class starting with the token name
# Read through the parse method to see the key used to store the value (or relevant part of the value).
# Open the Call hierarchy for the key to identify where the token’s value is processed.

@@ Line 29: / Line 29: @@
 # Test it out
 # Update the documentation
 ===Create a new token class===
@@ Line 58: / Line 60: @@
 ===Add a unit test or two===
-Tom has set up some great unit testing structures which will give your tag a full workout for little effort. Again, the best way is to copy and adjust the test for your example tag. You should be aiming to have a quick isolated test in the code/src/utest folder (e.g. OutputNameLstTest) and a parse/unparse test in the code/src/itest folder (e.g. OutputNameIntegrationTest). These will ensure that your new tags are wokring as you expect.
+Tom has set up some great unit testing structures which will give your tag a full workout for little effort. Again, the best way is to copy and adjust the test for your example tag. You should be aiming to have a quick isolated test in the code/src/utest folder (e.g. OutputNameLstTest) and a parse/unparse test in the code/src/itest folder (e.g. OutputNameIntegrationTest). These will ensure that your new tags are working as you expect.
 ===Update the pluginbuild.xml===
@@ Line 67: / Line 69: @@
 ===Update the documentation===
-The last step is updating the documentation. When you advance your NEWTAG entry in jira to say the tag is implemented it goes to the doco team. Now they will add i the doco when they get time, but if you want to help out, you can base a new doco entry on the syntax description in your NEWTAG issue. The sample tag you used above can also be a good guide fr how to enter it. Also don;t forget to mark it as new for the version you added it in.
+The last step is updating the documentation. When you advance your NEWTAG entry in jira to say the tag is implemented it goes to the docs team. Now they will add in the docs when they get time, but if you want to help out, you can base a new docs entry on the syntax description in your NEWTAG issue. The sample tag you used above can also be a good guide for how to enter it. Also don't forget to mark it as new for the version you added it in.

@@ Line 5: / Line 5: @@
 =Introduction=
 This guide is a collection of strategies and ways to tackle tasks in the PCGen code. It doesn’t try to be an architectural guide, for that I would start with [[Explanation_of_the_Code_Base]] , which is a good document to be familiar with.  There is also some good info at [[Architecture]]
 =Lst Tokens as an Entry Point=
@@ Line 15: / Line 21: @@
 # Read through the parse method to see the key used to store the value (or relevant part of the value).
 # Open the Call hierarchy for the key to identify where the token’s value is processed.