Architecture Changes 5.17

Primary Goals - Token/Loader

Prepare for LST Editor

These items benefit the LST editor system and are required in order to allow the editor system a "clean" round-robin of the data stored in PCC/LST files

1. Eliminate PCClass ABB being recognized by LoadContext as source-dependent FREQ 2671886 (DONE - SVN 9734)
2. Make .COPY in LST-files editor friendly FREQ 2700709 (DONE - SVN 9735)
3. Make .MOD in LST-files editor friendly FREQ 2700750 (DONE - SVN 9778)
4. Make .FORGET editor friendly FREQ 2715783 (DONE - SVN 9782)
5. Make PCClassLevel REPEATLEVEL in LST-files editor friendly FREQ 2687293
6. Rebuild/rename UDAM token to not "cross-pollute" in PCClassLevel FREQ 2671881
7. Make Ability CATEGORY recognized by LoadContext as source-dependent FREQ 2671888
8. Make Global KEY recognized by LoadContext as source dependent FREQ 2713303

Major Token Changes

These are major token changes that need to take place to sufficiently clean up the data syntax to avoid strange effects and requirements on the code.

1. Domain's CHOOSE:WEAPONPROF can have [WEAPONPROF], should be AUTO:WEAPONPROF:%LIST FREQ 1683356
2. Domain's CHOOSE:WEAPONPROF can have [FEAT=x] should get something like: AUTO:FEAT|x(%LIST) FREQ 1683356
3. CHOOSE:SPELLLEVEL can have funky arguments (BONUS), should be separate and use %LIST FREQ 2713306

(also See UDAM in Editor preparation)

Continue Token/Field Cleanup

These are cleanups similar to the major work that was done in PCGen 5.16. These are generally minor refactoring and cleanup, and most are non-invasive. Few of these are critical for the 5.17 cycle and could be ignored if necessary

1. ALL String based tokens (use StringKey) that support .CLEAR do so in a rather "different" way that is potentially not stable long-term. This should be reconsidered as to whether it is appropriate.
2. PCAlignment fields validForDeity, validForFollower can be in ObjectKey FREQ 2713314 (DONE - SVN 9784)
3. SizeAdjustment fields abbreviation, isDefaultSize can be in StringKey, ObjectKey FREQ 2713314 (DONE - SVN 9785)
4. PCStat fields abbreviation, statMod can be in StringKey FREQ 2713314 (DONE - SVN 9786)
5. PCStat field penaltyVar is useless - eliminate FREQ 2713314 (DONE - SVN 9786)
6. PCStat fields maxValue, minValue can be in IntegerKey FREQ 2713314 (DONE - SVN 9786)
7. PCStat field rolled can be in ObjectKey FREQ 2713314 (DONE - SVN 9786)
8. Kit statList can be in ListKey FREQ 2713314 (DONE - SVN 10116)
9. Kit tableMap can be in MapKey FREQ 2713314 (DONE - SVN 10116)
10. Global TEMPLATE supports .REMOVE suffix, should really be of the form REMOVE:TEMPLATE FREQ 1916482
11. Campaign isLoaded and isInitted are load-based (not static) and thus should be moved into CampaignLoader vs. stored in the Campaign itself FREQ 2713309 (DONE - SVN 10126, 10128)

CHOOSE Rebuild

This is the major token rebuild of CHOOSE, as proposed.

There is a significant discussion about separators for CHOOSE Separator Characters

Each of these are items that need to be built as "new" CHOOSE tokens:

1. CHOOSE:NOCHOICE (syntax remains unchanged)
2. CHOOSE:STRING (syntax remains unchanged)
3. CHOOSE:SCHOOLS
4. CHOOSE:PCSTAT (SVN 10023-10024) [TYPE not yet implemented, needs conversion of STAT]
5. CHOOSE:CHECK (DONE - SVN 10027)
6. CHOOSE:SIZE (DONE - SVN 10029)
7. CHOOSE:ALIGNMENT (SVN 10081) [TYPE not yet implemented]
8. CHOOSE:FEAT
9. CHOOSE:ABILITY -- FREQ 2204717
10. CHOOSE:LANG -- FREQ 2703701 (SVN 10083-4, 10098) [Needs conversion of LANGAUGE]
11. CHOOSE:EQUIPMENT (SVN 10085) [Needs conversion of EQUIPTYPE]
12. CHOOSE:TEMPLATE (DONE - SVN 10018-10021)
13. CHOOSE:SPELLS (syntax remains unchanged)
14. CHOOSE:ARMORPROFICIENCY (SVN 10086-87) [Needs conversion of ARMORPROF]
15. CHOOSE:SHIELDPROFICIENCY (SVN 10088) [Needs conversion of SHIELDPROF]
16. CHOOSE:DOMAIN
17. CHOOSE:DEITY -- FREQ 1738608 (DONE - SVN 10091, 10094, 10098, 10105)
18. CHOOSE:CLASS
19. CHOOSE:RACE
20. CHOOSE:SKILL -- FREQ 1001527 (SVN 10092-93, 10108)
21. CHOOSE:WEAPONPROFICIENCY -- FREQ 1102455 (SVN 10088, 10098)
22. CHOOSE:USERINPUT
23. ADD FEAT= target primitive (CHOOSE:FEAT=, CHOOSE:WEAPONFOCUS, FREQ 902288)
24. CHOOSE:ARMORTYPE To be deprecated - see FREQ 2713374 (DONE - SVN 10090)
25. CHOOSE:SALIST to be deprecated _exp 7364 (DONE - SVN 10089)
26. CHOOSE:SPELLLEVEL can be deprecated and replaced by CHOOSE:SPELLS if the BONUS issue is addressed.

The following have not been folded into the above proposals yet:

1. CHOOSE:HP
2. CHOOSE:SPELLLIST

Make Choice Selection Actions Type Safe

The following items are forced to convert the result of a CHOOSE from a String into a type safe object. Once the CHOOSE tokens are type safe, these can be converted to be type safe as well:

1. Global CSKILL
2. Global CCSKILL
3. AUTO:ARMORPROF
4. AUTO:EQUIP
5. AUTO:SHIELDPROF
6. AUTO:WEAPONPROF
7. Race FAVCLASS
8. Template FAVOREDCLASS
9. Race MONCSKILL

Leverage GroupingState

The following tokens use error detection that could consider leveraging the GroupingState system. Note that some of these will not benefit and should probably not be changed.

1. Global CCSKILL, COMPANIONLIST, CSKILL, KIT, LANGAUTO, QUALIFY (DONE - SVN 10129)
2. Add ABILITY, CLASSSKILLS (both), FEAT, LANGUAGE, SKILL, SPELLCASTER, VFEAT (DONE - SVN 10130)
3. Auto ARMORPROF, SHIELDPROF, WEAPONPROF
4. Deity DEITYWEAP, DOMAINS
5. Class LANGBONUS, SKILLLIST, SPELLLIST, WEAPONBONUS (DONE - SVN 10131)
6. Race CHOOSE:LANGAUTO, FAVCLASS, LANGBONUS, MONCCSKILL, MONCSKILL, WEAPONBONUS (DONE - SVN 10132)
7. Remove FEAT
8. Skill CLASSES
9. Template CHOOSE:LANGAUTO, FAVOREDCLASS, LANGBONUS, WEAPONBONUS (DONE - SVN 10133)

Primary Goals - Core

Eliminate Cloning

Cloning takes place when a PlayerCharacter uses an object and results in extra memory and a minor performance issue. However, once clones are removed, additional type safety work can be done to vastly improve performance.

Currently, Equipment and EquipmentModifier objects have been scoped out of PCGen 5.17 in order to minimize the required changes to the core

1. Eliminate Cloning of PCStat objects (Ability Scores) (DONE - SVN 9690)
2. Eliminate Cloning of Skill objects (DONE - SVN 9696)
3. Eliminate Cloning of Race objects (DONE - SVN 9700)
4. Eliminate Cloning of CompanionMod objects (DONE - SVN 9704)
5. Eliminate Cloning of Template objects (DONE - SVN 9705)
6. Eliminate Cloning of Spell objects (DONE - SVN 9707)
7. Eliminate Cloning of Domain objects (DONE - SVN 9709)
8. Eliminate Cloning of PCClass objects
9. Eliminate Cloning of Feat/Ability objects
10. Eliminate Cloning of EquipmentModifier objects (OUT OF SCOPE)
11. Eliminate Cloning of Equipment objects (OUT OF SCOPE)

Drive Type Safety and Performance

This represents the additional type safety work around performance for these object types. These changes cannot be done at the same time as the changes above, because they are significantly invasive, and must wait for a stable PCGen 5.16.0 where multi-version patching is no longer required.

Currently, Equipment and EquipmentModifier objects have been scoped out of PCGen 5.17 in order to minimize the required changes to the core

1. Eliminate Key/ABB comparison of PCStat object (DONE - SVN 9884-6, 9888-90, 9893-5, 9897, 9899, 9900)
2. Eliminate Key comparison of Skill objects (DONE - SVN 9991, 9997)
3. Eliminate Key comparison of Race objects (DONE - SVN 9989)
4. Eliminate Key comparison of CompanionMod objects
5. Eliminate Key comparison of Template objects (DONE - SVN 9993)
6. Eliminate Key comparison of Spell objects (DONE - SVN 10001)
7. Eliminate Key comparison of Domain objects
8. Eliminate Key comparison of PCClass objects
9. Eliminate Key comparison of SizeAdjustment objects (DONE - SVN 9990)
10. Eliminate Key comparison of PCAlignment objects (DONE - SVN 9994)
11. Eliminate Key comparison of Language objects (DONE - SVN 9995)
12. Eliminate Key comparison of Check (PObject) objects (DONE - SVN 10006)
13. Eliminate Key comparison of Feat/Ability objects
14. Eliminate Key comparison of WeaponProf objects (DONE - SVN 9998, 9999)
15. Eliminate Key comparison of EquipmentModifier objects (OUT OF SCOPE)
16. Eliminate Key comparison of Equipment objects (OUT OF SCOPE)

Player Character Facets

1. PC facet for PCStat objects
2. PC facet for Skill objects
3. PC facet for Race objects
4. PC facet for CompanionMod objects
5. PC facet for Template objects
6. PC facet for Spell objects
7. PC facet for Domain objects
8. PC facet for PCClass objects
9. PC facet for SizeAdjustment objects
10. PC facet for PCAlignment objects
11. PC facet for Language objects
12. PC facet for PCClass/PCClassLevel objects
13. PC facet for Check (PObject) objects
14. PC facet for Feat/Ability objects
15. PC facet for CompanionMod objects
16. PC facet for Proficiency objects
17. PC facet for Variables
18. PC facet for Bonuses
19. PC facet for XP
20. PC facet for Levels
21. PC facet for Movement
22. PC facet for AC
23. PC facet for Spell Info (books, etc.)
24. PC facet for Race Type
25. PC facet for Race Sub Type
26. PC facet for Legs
27. PC facet for Reach
28. PC facet for Hands
29. PC facet for Face
30. PC facet for Region
31. PC facet for Non Prof Penalty
32. PC facet for SubRace
33. PC facet for SubRegion
34. PC facet for Gender
35. PC facet for Equipment (OUT OF SCOPE)

Storage

1. Source-based (CDOM) storage of PCStat objects
2. Source-based (CDOM) storage of Skill objects
3. Source-based (CDOM) storage of Race objects
4. Source-based (CDOM) storage of CompanionMod objects
5. Source-based (CDOM) storage of Template objects
6. Source-based (CDOM) storage of Spell objects
7. Source-based (CDOM) storage of Domain objects
8. Source-based (CDOM) storage of PCClass objects
9. Source-based (CDOM) storage of SizeAdjustment objects
10. Source-based (CDOM) storage of PCAlignment objects
11. Source-based (CDOM) storage of Language objects
12. Source-based (CDOM) storage of PCClass objects
13. Source-based (CDOM) storage of Proficiency objects
14. Source-based (CDOM) storage of CompanionMod objects
15. Source-based (CDOM) storage of Check (PObject) objects
16. Source-based (CDOM) storage of Feat/Ability objects
17. Eliminate Key comparison of EquipmentModifier objects (OUT OF SCOPE)
18. Eliminate Key comparison of Equipment objects (OUT OF SCOPE)

Refactoring

These are architecture refactoring issues that generally involve breaking tangles and other work that is helpful to cleaning up the structure of the code

1. CharacterDomain is a useless class - delete (DONE - SVN 10000, 10010)
2. StatList is a useless class - delete (DONE - SVN 9996)
3. UnconstructedValidator should be an interface, not a class (DONE - SVN 10187)
4. Qualifier (in cdom.helper) is used in .reference, thus it should be in .reference, not .helper (DONE - SVN 10177)
5. CDOMObject methods addAdds, removeAdds, checkRemovals, driveChoice cause tangles, and should be in CDOMObjectUtilities not in CDOMObject (DONE - SVN 10136)
6. LoadContext should be an interface, not a class
7. PersistentChoiceActor decodeChoice often references the LoadContext, and should be discouraged from using Globals. This method should take the LoadContext as an argument.
8. Give CDOMObject (or a utility class) a method of consolidating out all of the ListKey-based joins in pcgen.core.spell.Spell.java (DONE - SVN 10181)
9. Ability.Nature should be in pcgen.cdom.enumeration (DONE - SVN 10135)
10. Spell Components should be in pcgen.cdom.enumeration (DONE - SVN 10181, 10183)
11. StatList getModForNumber(int, int) does a String replacement directly prior to a Formula evaluation, this should be moveable into a JEP variable for SCORE that is specific to stats. Actually, need to have the "SOURCE" field for TermEvaluatorBuilderPCVar COMPLETE_PC_SCORE be able to distinguish between STAT:Foo and BASESTAT:Foo and then this replacement would not be necessary.

Other

Unresolved Architectural Issues

Variables under Cloning

Certain items, such as variables that are dependent upon an object's name, are ill defined on cloning. Should the key name be swapped out, or should it remain intact. Behavior is inconsistent across objects. This problem is also apparent if KEY or CATEGORY is used in a .MOD

Languages with matching Key

The MSRD has multiple languages (some TYPE:Spoken, some TYPE:Read.Write) that share an identical key. Eventually this will become a significant problem, and it may need to be addressed during 5.17

Spells with matching Key

Similar to the TYPE issue for Languages above, the SRD has multiple "spells" (typically one Magical and one Psionic) that have the same name. They are distinguished by TYPE (Divine vs. Psionic, for example). This should be changed to something more intelligent than type, restoring KEY as a unique identifier. (One option here is to allow a form of CATEGORY for Spells - although the sharing of Arcane and Divine Types makes this a wee bit more complicated than just using CATEGORY as we know it today in Abilities)

Retroactivity

Much of this issue is discussed in this thread: http://tech.groups.yahoo.com/group/pcgen_experimental/message/6864

Prerequisite behavior

This is surfaced starting at this message: http://tech.groups.yahoo.com/group/pcgen_experimental/message/8133