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 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
|
{
FPDoc - Free Pascal Documentation Tool
Copyright (C) 2000 - 2003 by
Areca Systems GmbH / Sebastian Guenther, sg@freepascal.org
2005-2012 by
various FPC contributors
* Skeleton XML description file generator.
This generator scans Pascal source code for identifiers and emits XML files
suitable for further processing with the fpdoc documentation system:
users can edit the XML file and add (help) description.
See the file COPYING, included in this distribution,
for details about the copyright.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
}
program MakeSkel;
{$mode objfpc}
{$h+}
uses
SysUtils, Classes, Gettext,
dGlobals, PasTree, PParser,PScanner;
resourcestring
STitle = 'MakeSkel - FPDoc skeleton XML description file generator';
SVersion = 'Version %s [%s]';
SCmdLineHelp = 'See documentation for usage.';
SCmdLineInvalidOption = 'Ignoring unknown option "%s"';
SNoPackageNameProvided = 'Please specify a package name with --package=<name>';
SOutputMustNotBeDescr = 'Output file must be different from description filenames.';
SCreatingNewNode = 'Creating documentation for new node : %s';
SNodeNotReferenced = 'Documentation node "%s" no longer used';
SDone = 'Done.';
type
TCmdLineAction = (actionHelp, actionConvert);
TNodePair = Class(TObject)
Private
FEl : TPasElement;
FNode : TDocNode;
Public
Constructor Create(AnElement : TPasElement; ADocNode : TDocNode);
Property Element : TPasElement Read FEl;
Property DocNode : TDocNode Read FNode;
end;
TSkelEngine = class(TFPDocEngine)
Private
FEmittedList,
FNodeList,
FModules : TStringList;
Procedure DoWriteUnReferencedNodes(N : TDocNode; NodePath : String);
public
Destructor Destroy; override;
Function MustWriteElement(El : TPasElement; Full : Boolean) : Boolean;
Function WriteElement(Var F : Text; El : TPasElement; ADocNode : TDocNode) : Boolean;
function FindModule(const AName: String): TPasModule; override;
function CreateElement(AClass: TPTreeElement; const AName: String;
AParent: TPasElement; AVisibility :TPasMemberVisibility;
const ASourceFilename: String; ASourceLinenumber: Integer): TPasElement; override;
procedure WriteUnReferencedNodes;
Procedure WriteNodes(Var F : Text; AModule : TPasModule; List : TStrings);
Procedure DocumentFile(Var F : Text; Const AFileName,ATarget,ACPU : String);
Property NodeList : TStringList Read FNodeList;
Property EmittedList : TStringList Read FEmittedList;
end;
const
CmdLineAction: TCmdLineAction = actionConvert;
OSTarget: String = {$I %FPCTARGETOS%};
CPUTarget: String = {$I %FPCTARGETCPU%};
FPCVersion: String = {$I %FPCVERSION%};
FPCDate: String = {$I %FPCDATE%};
var
WriteDeclaration,
UpdateMode,
SortNodes,
DisableOverride,
DisableErrors,
DisableSeealso,
DisableArguments,
DisableProtected,
DisablePrivate,
DisableFunctionResults: Boolean;
EmitClassSeparator: Boolean;
Constructor TNodePair.Create(AnElement : TPasElement; ADocNode : TDocNode);
begin
Fel:=Anelement;
FNode:=ADocNode;
end;
function TSkelEngine.FindModule(const AName: String): TPasModule;
Var
I : Integer;
begin
Result:=Inherited FindModule(AName);
If (Result=Nil) then
begin // Create dummy list and search in that.
If (FModules=Nil) then
begin
FModules:=TStringList.Create;
FModules.Sorted:=True;
end;
I:=FModules.IndexOf(AName);
IF (I=-1) then
begin
Result:=TPasModule.Create(AName,Nil);
FModules.AddObject(AName,Result);
end
else
Result:=FModules.Objects[i] as TPasModule;
end;
end;
Destructor TSkelEngine.Destroy;
Var
I : Integer;
begin
If Assigned(FModules) then
begin
For I:=0 to FModules.Count-1 do
FModules.Objects[i].Free;
FreeAndNil(FModules);
end;
end;
Function TSkelEngine.MustWriteElement(El : TPasElement; Full : Boolean) : Boolean;
Var
ParentVisible:Boolean;
PT,PP : TPasElement;
begin
ParentVisible:=True;
If (El is TPasArgument) or (El is TPasResultElement) then
begin
PT:=El.Parent;
// Skip ProcedureType or PasFunctionType
If (PT<>Nil) then
begin
if (PT is TPasProcedureType) or (PT is TPasFunctionType) then
PT:=PT.Parent;
If (PT<>Nil) and ((PT is TPasProcedure) or (PT is TPasProcedure)) then
PP:=PT.Parent
else
PP:=Nil;
If (PP<>Nil) and (PP is TPasClassType) then
begin
ParentVisible:=((not DisablePrivate or (PT.Visibility<>visPrivate)) and
(not DisableProtected or (PT.Visibility<>visProtected)));
end;
end;
end;
Result:=Assigned(El.Parent) and (Length(El.Name) > 0) and
(ParentVisible and (not DisableArguments or (El.ClassType <> TPasArgument))) and
(ParentVisible and (not DisableFunctionResults or (El.ClassType <> TPasResultElement))) and
(not DisablePrivate or (el.Visibility<>visPrivate)) and
(not DisableProtected or (el.Visibility<>visProtected));
If Result and Full then
begin
Result:=(Not Assigned(FEmittedList) or (FEmittedList.IndexOf(El.FullName)=-1));
If DisableOverride and (El is TPasProcedure) then
Result:=Not TPasProcedure(El).IsOverride;
end;
end;
function TSkelEngine.CreateElement(AClass: TPTreeElement; const AName: String;
AParent: TPasElement; AVisibility : TPasMemberVisibility;
const ASourceFilename: String; ASourceLinenumber: Integer): TPasElement;
Var
DN : TDocNode;
begin
Result := AClass.Create(AName, AParent);
Result.Visibility:=AVisibility;
// Let function/procedure arguments and function results
// inherit visibility from their parents if visDefault visibility is
// specified.
// This allows easier text searches on visibility in the resulting XML
if (AVisibility=visDefault) and
((Result is TPasArgument) or (Result is TPasResultElement)) then
Result.Visibility:=AParent.Visibility;
if AClass.InheritsFrom(TPasModule) then
CurModule := TPasModule(Result);
// Track this element
If UpdateMode then
begin
DN:=FindDocNode(Result);
If Assigned(DN) then
DN.IncRefCount;
end
else
DN:=Nil;
// See if we need to write documentation for it
If MustWriteElement(Result,False) then
FNodeList.AddObject(Result.PathName,TNodePair.Create(Result,DN));
end;
Function TSkelEngine.WriteElement(Var F : Text;El : TPasElement; ADocNode : TDocNode) : Boolean;
Function WriteOnlyShort(APasElement : TPasElement) : Boolean;
begin
Result:=(APasElement.ClassType=TPasArgument) or
(APasElement.ClassType=TPasResultElement) or
(APasElement.ClassType=TPasEnumValue);
end;
Function IsTypeVarConst(APasElement : TPasElement) : Boolean;
begin
With APasElement do
Result:=(InheritsFrom(TPasType) and not InheritsFrom(TPasClassType)) or
(InheritsFrom(TPasResString)) or
(InheritsFrom(TPasVariable));
end;
Function NeedDeclaration(El : TPasElement) : boolean;
begin
Result:=IsTypeVarConst(El)
or WriteOnlyShort(El)
or EL.InheritsFrom(TPasProcedure)
end;
begin
// Check again, this time with full declaration.
Result:=MustWriteElement(El,True);
If Result and UpdateMode then
Result:=(ADocNode=Nil);
If Not Result Then
Exit;
If UpdateMode then
Writeln(stderr,Format(ScreatingNewNode,[el.PathName]));
FEmittedList.Add(El.FullName); // So we don't emit again.
WriteLn(f);
if EmitClassSeparator and (El.ClassType = TPasClassType) then
begin
WriteLn(f, '<!--');
WriteLn(f, ' ********************************************************************');
WriteLn(f, ' ', El.PathName);
WriteLn(f, ' ********************************************************************');
WriteLn(f, '-->');
WriteLn(f);
end;
If Not (WriteDeclaration and NeedDeclaration(El)) then
Writeln(F,'<!-- ', El.ElementTypeName,' Visibility: ',VisibilityNames[El.Visibility], ' -->')
else
begin
Writeln(F,'<!-- ',El.ElementTypeName,' Visibility: ',VisibilityNames[El.Visibility]);
Writeln(F,' Declaration: ',El.GetDeclaration(True),' -->');
end;
WriteLn(f,'<element name="', El.FullName, '">');
WriteLn(f, '<short></short>');
if Not WriteOnlyShort(El) then
begin
WriteLn(f, '<descr>');
WriteLn(f, '</descr>');
if not (DisableErrors or IsTypeVarConst(El)) then
begin
WriteLn(f, '<errors>');
WriteLn(f, '</errors>');
end;
if not DisableSeealso then
begin
WriteLn(f, '<seealso>');
WriteLn(f, '</seealso>');
end;
end;
WriteLn(f, '</element>');
end;
Procedure TSkelEngine.DoWriteUnReferencedNodes(N : TDocNode; NodePath : String);
begin
If (N<>Nil) then
begin
If (NodePath<>'') then
NodePath:=NodePath+'.';
DoWriteUnReferencedNodes(N.FirstChild,NodePath+N.Name);
While (N<>Nil) do
begin
if (N.RefCount=0) and (N.Node<>Nil) and (Not N.TopicNode) then
Writeln(stderr,Format(SNodeNotReferenced,[NodePath+N.Name]));
N:=N.NextSibling;
end;
end;
end;
procedure TSkelEngine.WriteUnReferencedNodes;
begin
DoWriteUnReferencedNodes(RootDocNode,'');
end;
Procedure TSkelEngine.WriteNodes(Var F : Text; AModule : TPasModule; List : TStrings);
Var
P : TNodePair;
I : integer;
begin
WriteLn(f);
WriteLn(f, '<!--');
WriteLn(f, ' ====================================================================');
WriteLn(f, ' ', Amodule.Name);
WriteLn(f, ' ====================================================================');
WriteLn(f, '-->');
WriteLn(f);
WriteLn(f, '<module name="', AModule.Name, '">');
if not UpdateMode then
begin
WriteLn(f, '<short></short>');
WriteLn(f, '<descr>');
WriteLn(f, '</descr>');
end;
Try
For I:=0 to List.Count-1 do
begin
P:=List.Objects[i] as TNodePair;
If (P.Element<>AModule) then
WriteElement(F,P.Element,P.DocNode);
end;
Finally
WriteLn(f, '');
WriteLn(f, '</module> <!-- ', AModule.Name, ' -->');
WriteLn(f, '');
end;
end;
Procedure TSkelEngine.DocumentFile(Var F : Text; Const AFileName,ATarget,ACPU : String);
Procedure ResolveOperators;
Var
E : TPasElement;
P : TNodePair;
N : TDocNode;
I : integer;
begin
For I:=0 to FNodeList.Count-1 do
begin
P:=TNodePair(FNodeList.Objects[i]);
if P.Element.InheritsFrom(TPasOperator) then
begin
N:=FindDocNode(P.Element);
If Assigned(N) then
N.IncRefCount;
P.FNode:=N;
end;
end;
end;
Var
Module : TPasModule;
I : Integer;
N : TDocNode;
begin
// wrong because afilename is a cmdline with other options. Straight testing filename is therefore wrong.
// if not(FileExists(AFileName)) then
// raise Exception.CreateFmt('Cannot find source file %s to document.',[AFileName]);
FNodeList:=TStringList.Create;
Try
FEmittedList:=TStringList.Create;
FEmittedList.Sorted:=True;
try
Module:=ParseSource(Self,AFileName,ATarget,ACPU);
If UpdateMode then
begin
N:=FindDocNode(Module);
If Assigned(N) then
N.IncRefCount;
ResolveOperators;
end;
If SortNodes then
FNodelist.Sorted:=True;
WriteNodes(F,Module,FNodeList);
If UpdateMode then
WriteUnReferencedNodes;
Finally
FEmittedList.Free;
end;
Finally
For I:=0 to FNodeList.Count-1 do
FNodeList.Objects[i].Free;
FNodeList.Free;
end;
end;
{ ---------------------------------------------------------------------
Main program. Document all units.
---------------------------------------------------------------------}
Function DocumentPackage(Const APackageName,AOutputName : String; InputFiles,DescrFiles : TStrings) : String;
Var
F : Text;
I,J : Integer;
Engine: TSkelEngine;
begin
Result:='';
Assign(f, AOutputName);
Rewrite(f);
Try
WriteLn(f, '<?xml version="1.0" encoding="ISO-8859-1"?>');
WriteLn(f, '<fpdoc-descriptions>');
WriteLn(f, '<package name="', APackageName, '">');
Try
I:=0;
While (Result='') And (I<InputFiles.Count) do
begin
Engine := TSkelEngine.Create;
Try
Engine.SetPackageName(APackageName);
if UpdateMode then
For J:=0 to DescrFiles.Count-1 do
Engine.AddDocFile(DescrFiles[J]);
Try
Engine.DocumentFile(F,InputFiles[I],OSTarget,CPUTarget);
except
on E:Exception do
begin
WriteLn('Error while documenting: '+E.message);
Result:='Error while documenting: '+E.message;
end;
end;
Finally
Engine.Free;
end;
Inc(I);
end;
Finally
WriteLn(f, '</package>');
WriteLn(f, '</fpdoc-descriptions>');
end;
finally
Close(f);
end;
end;
{ ---------------------------------------------------------------------
Option management
---------------------------------------------------------------------}
var
InputFiles,
DescrFiles : TStringList;
DocLang : String;
PackageName,
OutputName: String;
procedure InitOptions;
begin
InputFiles := TStringList.Create;
DescrFiles := TStringList.Create;
end;
procedure FreeOptions;
begin
DescrFiles.Free;
InputFiles.Free;
end;
procedure ParseOption(const s: String);
procedure AddToFileList(List: TStringList; const FileName: String);
var
f: Text;
s: String;
begin
if Copy(FileName, 1, 1) = '@' then
begin
Assign(f, Copy(FileName, 2, Length(FileName)));
Reset(f);
while not EOF(f) do
begin
ReadLn(f, s);
List.Add(s);
end;
Close(f);
end else
List.Add(FileName);
end;
var
i: Integer;
Cmd, Arg: String;
begin
if (s = '-h') or (s = '--help') then
CmdLineAction := actionHelp
else if s = '--update' then
UpdateMode := True
else if s = '--disable-arguments' then
DisableArguments := True
else if s = '--disable-errors' then
DisableErrors := True
else if s = '--disable-function-results' then
DisableFunctionResults := True
else if s = '--disable-seealso' then
DisableSeealso := True
else if s = '--disable-private' then
DisablePrivate := True
else if s = '--disable-override' then
DisableOverride := True
else if s = '--disable-protected' then
begin
DisableProtected := True;
DisablePrivate :=True;
end
else if (s = '--emitclassseparator') or (s='--emit-class-separator') then
EmitClassSeparator := True
else if (s = '--emit-declaration') then
WriteDeclaration := True
else if (s = '--sort-nodes') then
SortNodes := True
else
begin
i := Pos('=', s);
if i > 0 then
begin
Cmd := Copy(s, 1, i - 1);
Arg := Copy(s, i + 1, Length(s));
end else
begin
Cmd := s;
SetLength(Arg, 0);
end;
if (Cmd = '-i') or (Cmd = '--input') then
AddToFileList(InputFiles, Arg)
else if (Cmd = '-l') or (Cmd = '--lang') then
DocLang := Arg
else if (Cmd = '-o') or (Cmd = '--output') then
OutputName := Arg
else if Cmd = '--package' then
PackageName := Arg
else if Cmd = '--descr' then
begin
if FileExists(Arg) then
DescrFiles.Add(Arg);
end
else
WriteLn(StdErr, Format(SCmdLineInvalidOption, [s]));
end;
end;
Function ParseCommandLine : Integer;
Const
{$IFDEF Unix}
MoFileTemplate = '/usr/share/locale/%s/LC_MESSAGES/makeskel-' + {$include %FPCVERSION%} + '.mo';
{$ELSE}
MoFileTemplate ='intl/makeskel.%s.mo';
{$ENDIF}
var
MOFilename: string;
i: Integer;
begin
Result:=0;
DocLang:='';
for i := 1 to ParamCount do
ParseOption(ParamStr(i));
If (DocLang<>'') then
begin
MOFilename:=Format(MOFileTemplate,[DocLang]);
if FileExists(MOFilename) then
gettext.TranslateResourceStrings(MoFileName)
else
writeln('NOTE: unable to find translation file ',MOFilename);
// Translate internal documentation strings
TranslateDocStrings(DocLang);
end;
// Action is to create the XML skeleton
if (Length(PackageName) = 0) and (CmdLineAction<>ActionHelp) then
begin
WriteLn(SNoPackageNameProvided);
Result:=2;
end;
if DescrFiles.IndexOf(OutputName)<>-1 then
begin
Writeln(SOutputMustNotBeDescr);
Result:=3;
end;
end;
{ ---------------------------------------------------------------------
Usage
---------------------------------------------------------------------}
Procedure Usage;
begin
Writeln('Usage : ',ExtractFileName(Paramstr(0)),' [options]');
Writeln('Where [options] is one or more of :');
Writeln(' --descr=filename Filename for update.');
Writeln(' --disable-arguments Do not create nodes for function arguments.');
Writeln(' --disable-errors Do not create errors node.');
Writeln(' --disable-function-results');
Writeln(' Do not create nodes for function arguments.');
Writeln(' --disable-override Do not create nodes for override methods.');
Writeln(' --disable-private Do not create nodes for class private fields.');
Writeln(' --disable-protected Do not create nodes for class protected fields.');
Writeln(' --disable-seealso Do not create seealso node.');
Writeln(' --emit-class-separator');
Writeln(' Emit descriptive comment between classes.');
Writeln(' --emit-declaration Emit declaration for elements.');
Writeln(' --help Emit help.');
Writeln(' --input=cmdline Input file to create skeleton for.');
Writeln(' Use options are as for compiler.');
Writeln(' --lang=language Use selected language.');
Writeln(' --output=filename Send output to file.');
Writeln(' --package=name Specify package name (mandatory).');
Writeln(' --sort-nodes Sort element nodes (not modules)');
Writeln(' --update Update mode. Output only missing nodes.');
end;
{ ---------------------------------------------------------------------
Main Program
---------------------------------------------------------------------}
Procedure Run;
var
E: Integer;
begin
WriteLn(STitle);
WriteLn(Format(SVersion, [FPCVersion, FPCDate]));
WriteLn(SCopyright1);
WriteLn(SCopyright2);
InitOptions;
Try
E:=ParseCommandLine;
If E<>0 then
Halt(E);
WriteLn;
if CmdLineAction = actionHelp then
Usage
else
begin
DocumentPackage(PackageName,OutputName,InputFiles,DescrFiles);
WriteLn(SDone);
end;
Finally
FreeOptions;
end;
end;
Begin
Run;
end.
|