Scripting-Parser/KM_ScriptingParser.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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
unit KM_ScriptingParser;
interface
uses
  System.Classes, System.SysUtils, System.Types, Vcl.Forms, Winapi.Windows, System.Generics.Collections, System.IOUtils,
  System.StrUtils,
  KM_ScriptingCommon,
  KM_ScriptingMethods,
  KM_DocumenterPaths,
  KM_ScriptingTypes,
  KM_DocumenterTypes;

type
  // Documenter > Scripting
  TKMDocumenterScripting = class
  private const
    DBG_COPY_FOR_REFERENCE = True;
  private
    fParsingGame: TKMParsingGame;
    fOnLog: TProc<string>;
    fMethods: array [TKMScriptingArea] of TKMScriptingCommon;
    procedure CopyForReference(const aFilename: string; aArea: TKMScriptingArea);
  public
    constructor Create(aParsingGame: TKMParsingGame; aOnLog: TProc<string>);
    destructor Destroy; override;

    procedure GenerateCode(aPaths: TKMScriptingPathSet);
    procedure GenerateWiki(aPaths: TKMScriptingPathSet);
    procedure LintMessages(aPaths: TKMScriptingPathSet);
    procedure GenerateXML(aPaths: TKMScriptingPathSet);
  end;


implementation


type
  TKMScriptingAreaClass = class of TKMScriptingCommon;

const
  CLASS_OF: array [TKMScriptingArea] of TKMScriptingAreaClass = (
    TKMScriptingMethods,
    TKMScriptingMethods,
    TKMScriptingMethods,
    TKMScriptingMethods,
    TKMScriptingTypes
  );


{ TKMDocumenterScripting }
constructor TKMDocumenterScripting.Create(aParsingGame: TKMParsingGame; aOnLog: TProc<string>);
begin
  inherited Create;

  fParsingGame := aParsingGame;
  fOnLog := aOnLog;

  for var I := Low(TKMScriptingArea) to High(TKMScriptingArea) do
    fMethods[I] := CLASS_OF[I].Create(fParsingGame, I, fOnLog);
end;


destructor TKMDocumenterScripting.Destroy;
begin
  for var I := Low(TKMScriptingArea) to High(TKMScriptingArea) do
    FreeAndNil(fMethods[I]);

  inherited;
end;


procedure TKMDocumenterScripting.CopyForReference(const aFilename: string; aArea: TKMScriptingArea);
var
  tgtPath: string;
begin
  tgtPath := ExtractFilePath(Application.ExeName) + GAME_INFO[fParsingGame].Ext + '.' + SCRIPTING_AREA_SPEC[aArea].Name + '.new.md';
  Winapi.Windows.CopyFile(PChar(aFilename), PChar(tgtPath), False);
end;


procedure TKMDocumenterScripting.GenerateCode(aPaths: TKMScriptingPathSet);
begin
  //todo -cThink: Automate verification in ScriptingParser that functions/procedures pose under the same name in LogMissionWarning
  // Arrays can be declared in 2 ways in KP PS - "array of string" and TKMStringArray. First one is more traditional and more universal.
  // Second one is required for some Utils methods to allow for resizing of passed arrays. Resized arrays become TKMStringArray though.
  // Now, some functions in Actions expect string arrays. Problem is that they must be declared as TKMStringArray to accept both TKMStringArray and "array of"
  //todo -cThink: Hence we need to add such a check in here. KP arrays need to be declared as TKMStringArray (Integer/Single/etc)

  for var I := Low(TKMScriptingArea) to High(TKMScriptingArea) do
    fMethods[I].GenerateCode(aPaths[I].SourceInput, aPaths[I].SourceOutput1, aPaths[I].SourceOutput2);
end;


procedure TKMDocumenterScripting.GenerateWiki(aPaths: TKMScriptingPathSet);
begin
  for var I := Low(TKMScriptingArea) to High(TKMScriptingArea) do
    fMethods[I].GenerateWiki(aPaths[I].SourceInput, aPaths[I].WikiTemplate, aPaths[I].WikiOutput);

  if DBG_COPY_FOR_REFERENCE then
    for var I := Low(TKMScriptingArea) to High(TKMScriptingArea) do
      CopyForReference(aPaths[I].WikiOutput, I);
end;


procedure TKMDocumenterScripting.LintMessages(aPaths: TKMScriptingPathSet);
begin
  fMethods[paActions].LintLogMessages(aPaths[paActions].SourceInput);
  // Events dont have log messages
  fMethods[paStates].LintLogMessages(aPaths[paStates].SourceInput);
  fMethods[paUtils].LintLogMessages(aPaths[paUtils].SourceInput);
  // Utils dont have log messages
end;


procedure TKMDocumenterScripting.GenerateXML(aPaths: TKMScriptingPathSet);
begin
  //todo -cThink: GenerateXML for ScriptingEditor
end;


end.