Scripting-Parser/KM_DocumenterTypes.pas at master · KP-Wiki/Scripting-Parser · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
unit KM_DocumenterTypes;
interface


type
  TKMParsingGame = (pgKaMRemake, pgKnightsProvince);
  TKMScriptingArea = (paActions, paEvents, paStates, paUtils, paTypes);

  // Set of paths required for one job
  TKMDocumenterPathSet = record
  public
    SourceInput: string;    // Supports wildcards
    WikiTemplate: string;
    WikiOutput: string;
    SourceOutput1: string;
    SourceOutput2: string;
  end;

const
  GAME_INFO: array [TKMParsingGame] of record Ext, Name: string; end = (
    (Ext: 'kmr'; Name: 'KaM Remake'),
    (Ext: 'kp';  Name: 'Knights Province')
  );

  LOG_MESSAGE_NAME: array [TKMParsingGame] of string = (
    'LogParamWarn',   // KMR
    'LogParamWarning' // KP
  );

  // Denotes specification details for scripting domains (Events, States, Actions, Types, Utils)
  SCRIPTING_AREA_SPEC: array [TKMScriptingArea] of record
    Name: string;         // Name of the area. Used in the logs and for reference md-s in this repo
    CheckTag: string;     // Tag used for the Check region
    RegTag: string;       // Tag used for the Register region
    NeedsReturn: Boolean; // Whether wiki needs return type column for this area (Actions, States, Utils)
  end = (
    (Name: 'Actions'; CheckTag: '//*Area-Actions-Check*//'; RegTag:'//*Area-Actions-Reg*//'; NeedsReturn: True),
    (Name: 'Events';  CheckTag: '//*Area-Events-Check*//';  RegTag:'//*Area-Events-Reg*//';  NeedsReturn: False),
    (Name: 'States';  CheckTag: '//*Area-States-Check*//';  RegTag:'//*Area-States-Reg*//';  NeedsReturn: True),
    (Name: 'Utils';   CheckTag: '//*Area-Utils-Check*//';   RegTag:'//*Area-Utils-Reg*//';   NeedsReturn: True),
    (Name: 'Types';   CheckTag: '//*Area-Types-Check*//';   RegTag:'//*Area-Types-Reg*//';   NeedsReturn: False)
  );


  // Long comments may contain whole paragraphs, hence //* has to stay without a whitespace
  DOC_TAG = '//*';
  DOC_TAG_VERSION = '//* Version:';
  DOC_TAG_STATUS = '//* Status:';
  DOC_TAG_STATUS_DEPRECATED = 'Deprecated';
  DOC_TAG_STATUS_CHANGED = 'Changed';
  DOC_TAG_STATUS_REMOVED = 'Removed';
  DOC_TAG_REPLACEMENT = '//* Replacement:';
  DOC_TAG_RESULT = '//* Result:';

  DOC_TAG_AREA = '//*Area';

  // We need to annotate modding regions to avoid clashing with Type declarations
  DOC_TAG_AREA_MODDING_DEFINITION = '//*Area-Modding-Definition*//';

  // Modding types
  DOC_TAG_MODDING_TYPE_IS_ROOT      = '//* Type-IsRoot:';       // Root type
  DOC_TAG_MODDING_TYPE_NAME         = '//* Type-Name:';         // Type name when it is impractical to parse
  DOC_TAG_MODDING_TYPE_NODENAME     = '//* Type-NodeName:';     // Next line will contain xml node name
  DOC_TAG_MODDING_TYPE_CAPTION      = '//* Type-Caption:';      // Caption name
  DOC_TAG_MODDING_TYPE_DESCRIPTION  = '//* Type-Description:';  // Description
  DOC_TAG_MODDING_TYPE_SPECIALTY    = '//* Type-Specialty:';    // Special

  // Modding attributes and nodes
  DOC_TAG_MODDING_ATTR_DEFAULT        = '//* Attr-Default:';      // Default value for the attribute
  DOC_TAG_MODDING_ATTR_CARDINALITY    = '//* Attr-Cardinality:';  // Attribute cardinality
  DOC_TAG_MODDING_NODE_CARDINALITY    = '//* Node-Cardinality:';  // Node cardinality
  DOC_TAG_MODDING_REFERENCE_NODE      = '//* Reference-Node:';    // Reference to another type
  DOC_TAG_MODDING_REFERENCE_ATTR      = '//* Reference-Attr:';    // Reference to another type
  DOC_TAG_MODDING_LIST_FOR_NEXT_NODE  = '//* ListForNextNode:';     // Reference to another type


type
  TKMModdingTypeSpecialty = (
    mtsNormal,
    mtsSemicolonDelimitedArray,
    mtsList,
    mtsEnum,
    mtsEnumSet
  );

const
  MODDING_TYPE_SPECIALTY_NAME: array [TKMModdingTypeSpecialty] of string = (
    '',
    'SemicolonDelimitedArray',
    'List',
    'Enum',
    'EnumSet'
  );


implementation


end.