dw_html.pp 84 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951
  1. {
  2. FPDoc - Free Pascal Documentation Tool
  3. Copyright (C) 2000 - 2005 by
  4. Areca Systems GmbH / Sebastian Guenther, [email protected]
  5. * HTML/XHTML output generator
  6. See the file COPYING, included in this distribution,
  7. for details about the copyright.
  8. This program is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  11. }
  12. {$mode objfpc}
  13. {$H+}
  14. unit dw_HTML;
  15. interface
  16. uses Classes, DOM, DOM_HTML, dGlobals, PasTree, dWriter;
  17. const
  18. // Subpage indices for modules
  19. ResstrSubindex = 1;
  20. ConstsSubindex = 2;
  21. TypesSubindex = 3;
  22. ClassesSubindex = 4;
  23. ProcsSubindex = 5;
  24. VarsSubindex = 6;
  25. // Maybe needed later for topic overview ??
  26. TopicsSubIndex = 7;
  27. // Subpage indices for classes
  28. PropertiesByInheritanceSubindex = 1;
  29. PropertiesByNameSubindex = 2;
  30. MethodsByInheritanceSubindex = 3;
  31. MethodsByNameSubindex = 4;
  32. EventsByInheritanceSubindex = 5;
  33. EventsByNameSubindex = 6;
  34. type
  35. TFileAllocator = class
  36. public
  37. procedure AllocFilename(AElement: TPasElement; ASubindex: Integer); virtual;
  38. function GetFilename(AElement: TPasElement;
  39. ASubindex: Integer): String; virtual; abstract;
  40. function GetRelativePathToTop(AElement: TPasElement): String; virtual;
  41. function GetCSSFilename(ARelativeTo: TPasElement): DOMString; virtual;
  42. end;
  43. TShortNameFileAllocator = class(TFileAllocator)
  44. private
  45. FExtension: String;
  46. public
  47. constructor Create(const AExtension: String);
  48. procedure AllocFilename(AElement: TPasElement; ASubindex: Integer); override;
  49. property Extension: String read FExtension;
  50. end;
  51. TLongNameFileAllocator = class(TFileAllocator)
  52. private
  53. FExtension: String;
  54. public
  55. constructor Create(const AExtension: String);
  56. function GetFilename(AElement: TPasElement;
  57. ASubindex: Integer): String; override;
  58. function GetRelativePathToTop(AElement: TPasElement): String; override;
  59. property Extension: String read FExtension;
  60. end;
  61. TPageInfo = class
  62. Element: TPasElement;
  63. SubpageIndex: Integer;
  64. end;
  65. { THTMLWriter }
  66. THTMLWriter = class(TFPDocWriter)
  67. private
  68. FOnTest: TNotifyEvent;
  69. FPackage: TPasPackage;
  70. function GetPageCount: Integer;
  71. procedure SetOnTest(const AValue: TNotifyEvent);
  72. protected
  73. FAllocator: TFileAllocator;
  74. Procedure CreateAllocator; virtual;
  75. CurDirectory: String; // relative to curdir of process
  76. BaseDirectory: String; // relative path to package base directory
  77. PageInfos: TObjectList; // list of TPageInfo objects
  78. Doc: THTMLDocument;
  79. BodyElement, TitleElement: TDOMElement;
  80. Module: TPasModule;
  81. OutputNodeStack: TList;
  82. CurOutputNode: TDOMNode;
  83. InsideHeadRow, DoPasHighlighting: Boolean;
  84. HighlighterFlags: Byte;
  85. FooterFile: string;
  86. function ResolveLinkID(const Name: String): DOMString;
  87. function ResolveLinkWithinPackage(AElement: TPasElement;
  88. ASubpageIndex: Integer): String;
  89. // Helper functions for creating DOM elements
  90. function CreateEl(Parent: TDOMNode; const AName: DOMString): THTMLElement;
  91. function CreatePara(Parent: TDOMNode): THTMLElement;
  92. function CreateH1(Parent: TDOMNode): THTMLElement;
  93. function CreateH2(Parent: TDOMNode): THTMLElement;
  94. function CreateH3(Parent: TDOMNode): THTMLElement;
  95. function CreateTable(Parent: TDOMNode): THTMLElement;
  96. function CreateContentTable(Parent: TDOMNode): THTMLElement;
  97. function CreateTR(Parent: TDOMNode): THTMLElement;
  98. function CreateTD(Parent: TDOMNode): THTMLElement;
  99. function CreateTD_vtop(Parent: TDOMNode): THTMLElement;
  100. function CreateLink(Parent: TDOMNode; const AHRef: DOMString): THTMLElement;
  101. function CreateAnchor(Parent: TDOMNode; const AName: DOMString): THTMLElement;
  102. function CreateCode(Parent: TDOMNode): THTMLElement;
  103. function CreateWarning(Parent: TDOMNode): THTMLElement;
  104. // Description node conversion
  105. procedure PushOutputNode(ANode: TDOMNode);
  106. procedure PopOutputNode;
  107. procedure DescrWriteText(const AText: DOMString); override;
  108. procedure DescrBeginBold; override;
  109. procedure DescrEndBold; override;
  110. procedure DescrBeginItalic; override;
  111. procedure DescrEndItalic; override;
  112. procedure DescrBeginEmph; override;
  113. procedure DescrEndEmph; override;
  114. procedure DescrWriteFileEl(const AText: DOMString); override;
  115. procedure DescrWriteKeywordEl(const AText: DOMString); override;
  116. procedure DescrWriteVarEl(const AText: DOMString); override;
  117. procedure DescrBeginLink(const AId: DOMString); override;
  118. procedure DescrEndLink; override;
  119. procedure DescrWriteLinebreak; override;
  120. procedure DescrBeginParagraph; override;
  121. procedure DescrEndParagraph; override;
  122. procedure DescrBeginCode(HasBorder: Boolean; const AHighlighterName: String); override;
  123. procedure DescrWriteCodeLine(const ALine: String); override;
  124. procedure DescrEndCode; override;
  125. procedure DescrBeginOrderedList; override;
  126. procedure DescrEndOrderedList; override;
  127. procedure DescrBeginUnorderedList; override;
  128. procedure DescrEndUnorderedList; override;
  129. procedure DescrBeginDefinitionList; override;
  130. procedure DescrEndDefinitionList; override;
  131. procedure DescrBeginListItem; override;
  132. procedure DescrEndListItem; override;
  133. procedure DescrBeginDefinitionTerm; override;
  134. procedure DescrEndDefinitionTerm; override;
  135. procedure DescrBeginDefinitionEntry; override;
  136. procedure DescrEndDefinitionEntry; override;
  137. procedure DescrBeginSectionTitle; override;
  138. procedure DescrBeginSectionBody; override;
  139. procedure DescrEndSection; override;
  140. procedure DescrBeginRemark; override;
  141. procedure DescrEndRemark; override;
  142. procedure DescrBeginTable(ColCount: Integer; HasBorder: Boolean); override;
  143. procedure DescrEndTable; override;
  144. procedure DescrBeginTableCaption; override;
  145. procedure DescrEndTableCaption; override;
  146. procedure DescrBeginTableHeadRow; override;
  147. procedure DescrEndTableHeadRow; override;
  148. procedure DescrBeginTableRow; override;
  149. procedure DescrEndTableRow; override;
  150. procedure DescrBeginTableCell; override;
  151. procedure DescrEndTableCell; override;
  152. procedure AppendText(Parent: TDOMNode; const AText: DOMString);
  153. procedure AppendNbSp(Parent: TDOMNode; ACount: Integer);
  154. procedure AppendSym(Parent: TDOMNode; const AText: DOMString);
  155. procedure AppendKw(Parent: TDOMNode; const AText: DOMString);
  156. function AppendPasSHFragment(Parent: TDOMNode; const AText: String;
  157. AShFlags: Byte): Byte;
  158. Procedure AppendShortDescr(AContext : TPasElement;Parent: TDOMNode; DocNode : TDocNode);
  159. procedure AppendShortDescr(Parent: TDOMNode; Element: TPasElement);
  160. procedure AppendDescr(AContext: TPasElement; Parent: TDOMNode;
  161. DescrNode: TDOMElement; AutoInsertBlock: Boolean);
  162. procedure AppendDescrSection(AContext: TPasElement; Parent: TDOMNode;
  163. DescrNode: TDOMElement; const ATitle: DOMString);
  164. procedure AppendShortDescrCell(Parent: TDOMNode; Element: TPasElement);
  165. function AppendHyperlink(Parent: TDOMNode; Element: TPasElement): TDOMElement;
  166. function AppendType(CodeEl, TableEl: TDOMElement;
  167. Element: TPasType; Expanded: Boolean;
  168. NestingLevel: Integer = 0): TDOMElement;
  169. function AppendProcType(CodeEl, TableEl: TDOMElement;
  170. Element: TPasProcedureType; Indent: Integer): TDOMElement;
  171. procedure AppendProcExt(CodeEl: TDOMElement; Element: TPasProcedure);
  172. procedure AppendProcDecl(CodeEl, TableEl: TDOMElement;
  173. Element: TPasProcedureBase);
  174. procedure AppendProcArgsSection(Parent: TDOMNode;
  175. Element: TPasProcedureType);
  176. function AppendRecordType(CodeEl, TableEl: TDOMElement;
  177. Element: TPasRecordType; NestingLevel: Integer): TDOMElement;
  178. procedure AppendTitle(const AText: DOMString);
  179. procedure AppendMenuBar(ASubpageIndex: Integer);
  180. procedure AppendTopicMenuBar(Topic : TTopicElement);
  181. procedure AppendSourceRef(AElement: TPasElement);
  182. procedure FinishElementPage(AElement: TPasElement);
  183. Procedure AppendSeeAlsoSection(AElement : TPasElement;DocNode : TDocNode);
  184. Procedure AppendExampleSection(AElement : TPasElement;DocNode : TDocNode);
  185. procedure AppendFooter;
  186. procedure CreatePageBody(AElement: TPasElement; ASubpageIndex: Integer); virtual;
  187. procedure CreatePackagePageBody;
  188. Procedure CreateTopicPageBody(AElement : TTopicElement);
  189. procedure CreateModulePageBody(AModule: TPasModule; ASubpageIndex: Integer);
  190. procedure CreateConstPageBody(AConst: TPasConst);
  191. procedure CreateTypePageBody(AType: TPasType);
  192. procedure CreateClassPageBody(AClass: TPasClassType; ASubpageIndex: Integer);
  193. procedure CreateClassMemberPageBody(AElement: TPasElement);
  194. procedure CreateVarPageBody(AVar: TPasVariable);
  195. procedure CreateProcPageBody(AProc: TPasProcedureBase);
  196. Procedure CreateTopicLinks(Node : TDocNode; PasElement : TPasElement);
  197. public
  198. constructor Create(APackage: TPasPackage; AEngine: TFPDocEngine); override;
  199. destructor Destroy; override;
  200. // Single-page generation
  201. function CreateHTMLPage(AElement: TPasElement;
  202. ASubpageIndex: Integer): TXMLDocument;
  203. function CreateXHTMLPage(AElement: TPasElement;
  204. ASubpageIndex: Integer): TXMLDocument;
  205. // For producing complete package documentation
  206. procedure WriteHTMLPages;
  207. procedure WriteXHTMLPages;
  208. SearchPage: String;
  209. property Allocator: TFileAllocator read FAllocator;
  210. property Package: TPasPackage read FPackage;
  211. property PageCount: Integer read GetPageCount;
  212. property OnTest: TNotifyEvent read FOnTest write SetOnTest;
  213. Function InterPretOption(Const Cmd,Arg : String) : boolean; override;
  214. Procedure WriteDoc; override;
  215. class procedure Usage(List: TStrings); override;
  216. end;
  217. THTMWriter = class(THTMLWriter)
  218. Protected
  219. Procedure CreateAllocator; override;
  220. end;
  221. implementation
  222. uses SysUtils, XHTML, XMLRead, XMLWrite, HTMWrite, sh_pas;
  223. Function FixHTMLpath(S : String) : STring;
  224. begin
  225. Result:=StringReplace(S,'\','/',[rfReplaceAll]);
  226. end;
  227. procedure TFileAllocator.AllocFilename(AElement: TPasElement;
  228. ASubindex: Integer);
  229. begin
  230. end;
  231. function TFileAllocator.GetRelativePathToTop(AElement: TPasElement): String;
  232. begin
  233. SetLength(Result, 0);
  234. end;
  235. function TFileAllocator.GetCSSFilename(ARelativeTo: TPasElement): DOMString;
  236. begin
  237. Result := GetRelativePathToTop(ARelativeTo) + 'fpdoc.css';
  238. end;
  239. constructor TShortNameFileAllocator.Create(const AExtension: String);
  240. begin
  241. inherited Create;
  242. FExtension := AExtension;
  243. end;
  244. procedure TShortNameFileAllocator.AllocFilename(AElement: TPasElement;
  245. ASubindex: Integer);
  246. begin
  247. // !!!: Add element to file list
  248. end;
  249. constructor TLongNameFileAllocator.Create(const AExtension: String);
  250. begin
  251. inherited Create;
  252. FExtension := AExtension;
  253. end;
  254. function TLongNameFileAllocator.GetFilename(AElement: TPasElement;
  255. ASubindex: Integer): String;
  256. var
  257. i: Integer;
  258. begin
  259. if AElement.ClassType = TPasPackage then
  260. Result := 'index'
  261. else if AElement.ClassType = TPasModule then
  262. Result := LowerCase(AElement.Name) + PathDelim + 'index'
  263. else
  264. begin
  265. Result := LowerCase(AElement.PathName);
  266. i := 1;
  267. if (Length(Result)>0) and (Result[1]='#') then
  268. begin
  269. while Result[i] <> '.' do
  270. Inc(i);
  271. Result:=Copy(Result,i+1,Length(Result));
  272. end;
  273. i := 1;
  274. while (I<=Length(Result)) and (Result[i]<>'.') do
  275. Inc(i);
  276. If (I<=Length(Result)) and (I>0) then
  277. Result[i]:= PathDelim;
  278. end;
  279. if ASubindex > 0 then
  280. Result := Result + '-' + IntToStr(ASubindex);
  281. Result := Result + Extension;
  282. end;
  283. function TLongNameFileAllocator.GetRelativePathToTop(AElement: TPasElement): String;
  284. begin
  285. if (AElement.ClassType=TPasPackage) then
  286. Result := ''
  287. else if (AElement.ClassType=TTopicElement) then
  288. begin
  289. If (AElement.Parent.ClassType=TTopicElement) then
  290. Result:='../'+GetRelativePathToTop(AElement.Parent)
  291. else if (AElement.Parent.ClassType=TPasPackage) then
  292. Result:=''
  293. else if (AElement.Parent.ClassType=TPasModule) then
  294. Result:='../';
  295. end
  296. else
  297. Result := '../';
  298. end;
  299. constructor THTMLWriter.Create(APackage: TPasPackage; AEngine: TFPDocEngine);
  300. procedure AddPage(AElement: TPasElement; ASubpageIndex: Integer);
  301. var
  302. PageInfo: TPageInfo;
  303. begin
  304. PageInfo := TPageInfo.Create;
  305. PageInfo.Element := AElement;
  306. PageInfo.SubpageIndex := ASubpageIndex;
  307. PageInfos.Add(PageInfo);
  308. Allocator.AllocFilename(AElement, ASubpageIndex);
  309. if ASubpageIndex = 0 then
  310. Engine.AddLink(AElement.PathName,
  311. Allocator.GetFilename(AElement, ASubpageIndex));
  312. end;
  313. procedure AddTopicPages(AElement: TPasElement);
  314. var
  315. PreviousTopic,
  316. TopicElement : TTopicElement;
  317. PageInfo : TPageInfo;
  318. DocNode,
  319. TopicNode : TDocNode;
  320. begin
  321. DocNode:=Engine.FindDocNode(AElement);
  322. If not Assigned(DocNode) then
  323. exit;
  324. TopicNode:=DocNode.FirstChild;
  325. PreviousTopic:=Nil;
  326. While Assigned(TopicNode) do
  327. begin
  328. If TopicNode.TopicNode then
  329. begin
  330. TopicElement:=TTopicElement.Create(TopicNode.Name,AElement);
  331. Topics.Add(TopicElement);
  332. TopicElement.TopicNode:=TopicNode;
  333. TopicElement.Previous:=PreviousTopic;
  334. If Assigned(PreviousTopic) then
  335. PreviousTopic.Next:=TopicElement;
  336. PreviousTopic:=TopicElement;
  337. if AElement is TTopicElement then
  338. TTopicElement(AElement).SubTopics.Add(TopicElement);
  339. PageInfo := TPageInfo.Create;
  340. PageInfo.Element := TopicElement;
  341. PageInfo.SubpageIndex := 0;
  342. PageInfos.Add(PageInfo);
  343. Allocator.AllocFilename(TopicElement,0);
  344. Engine.AddLink(TopicElement.PathName, Allocator.GetFilename(TopicElement,0));
  345. if AElement is TTopicElement then
  346. TTopicElement(AElement).SubTopics.Add(TopicElement)
  347. else // Only one level of recursion.
  348. AddTopicPages(TopicElement);
  349. end;
  350. TopicNode:=TopicNode.NextSibling;
  351. end;
  352. end;
  353. procedure AddPages(AElement: TPasElement; ASubpageIndex: Integer;
  354. AList: TList);
  355. var
  356. i: Integer;
  357. begin
  358. if AList.Count > 0 then
  359. begin
  360. AddPage(AElement, ASubpageIndex);
  361. for i := 0 to AList.Count - 1 do
  362. AddPage(TPasElement(AList[i]), 0);
  363. end;
  364. end;
  365. procedure ScanModule(AModule: TPasModule);
  366. var
  367. i, j, k: Integer;
  368. s: String;
  369. ClassEl: TPasClassType;
  370. FPEl, AncestorMemberEl: TPasElement;
  371. DocNode: TDocNode;
  372. DidAutolink: Boolean;
  373. begin
  374. AddPage(AModule, 0);
  375. AddTopicPages(AModule);
  376. with AModule do
  377. begin
  378. if InterfaceSection.ResStrings.Count > 0 then
  379. begin
  380. AddPage(AModule, ResstrSubindex);
  381. s := Allocator.GetFilename(AModule, ResstrSubindex);
  382. for i := 0 to InterfaceSection.ResStrings.Count - 1 do
  383. with TPasResString(InterfaceSection.ResStrings[i]) do
  384. Engine.AddLink(PathName, s + '#' + LowerCase(Name));
  385. end;
  386. AddPages(AModule, ConstsSubindex, InterfaceSection.Consts);
  387. AddPages(AModule, TypesSubindex, InterfaceSection.Types);
  388. if InterfaceSection.Classes.Count > 0 then
  389. begin
  390. AddPage(AModule, ClassesSubindex);
  391. for i := 0 to InterfaceSection.Classes.Count - 1 do
  392. begin
  393. ClassEl := TPasClassType(InterfaceSection.Classes[i]);
  394. AddPage(ClassEl, 0);
  395. // !!!: Only add when there are items
  396. AddPage(ClassEl, PropertiesByInheritanceSubindex);
  397. AddPage(ClassEl, PropertiesByNameSubindex);
  398. AddPage(ClassEl, MethodsByInheritanceSubindex);
  399. AddPage(ClassEl, MethodsByNameSubindex);
  400. AddPage(ClassEl, EventsByInheritanceSubindex);
  401. AddPage(ClassEl, EventsByNameSubindex);
  402. for j := 0 to ClassEl.Members.Count - 1 do
  403. begin
  404. FPEl := TPasElement(ClassEl.Members[j]);
  405. if ((FPEl.Visibility = visPrivate) and Engine.HidePrivate) or
  406. ((FPEl.Visibility = visProtected) and Engine.HideProtected) then
  407. continue;
  408. DocNode := Engine.FindDocNode(FPEl);
  409. if not Assigned(DocNode) then
  410. begin
  411. DidAutolink := False;
  412. if Assigned(ClassEl.AncestorType) and
  413. (ClassEl.AncestorType.ClassType = TPasClassType) then
  414. begin
  415. for k := 0 to TPasClassType(ClassEl.AncestorType).Members.Count - 1 do
  416. begin
  417. AncestorMemberEl :=
  418. TPasElement(TPasClassType(ClassEl.AncestorType).Members[k]);
  419. if AncestorMemberEl.Name = FPEl.Name then
  420. begin
  421. DocNode := Engine.FindDocNode(AncestorMemberEl);
  422. if Assigned(DocNode) then
  423. begin
  424. DidAutolink := True;
  425. Engine.AddLink(FPEl.PathName,
  426. Engine.FindAbsoluteLink(AncestorMemberEl.PathName));
  427. break;
  428. end;
  429. end;
  430. end;
  431. end;
  432. if not DidAutolink then
  433. AddPage(FPEl, 0);
  434. end else
  435. AddPage(FPEl, 0);
  436. end;
  437. end;
  438. end;
  439. AddPages(AModule, ProcsSubindex, InterfaceSection.Functions);
  440. AddPages(AModule, VarsSubindex, InterfaceSection.Variables);
  441. end;
  442. end;
  443. var
  444. i: Integer;
  445. begin
  446. inherited ;
  447. CreateAllocator;
  448. FPackage := APackage;
  449. OutputNodeStack := TList.Create;
  450. PageInfos := TObjectList.Create;
  451. // Allocate page for the package itself, if a name is given (i.e. <> '#')
  452. if Length(Package.Name) > 1 then
  453. begin
  454. AddPage(Package, 0);
  455. AddTopicPages(Package);
  456. end;
  457. for i := 0 to Package.Modules.Count - 1 do
  458. ScanModule(TPasModule(Package.Modules[i]));
  459. end;
  460. destructor THTMLWriter.Destroy;
  461. begin
  462. PageInfos.Free;
  463. OutputNodeStack.Free;
  464. inherited Destroy;
  465. end;
  466. function THTMLWriter.CreateHTMLPage(AElement: TPasElement;
  467. ASubpageIndex: Integer): TXMLDocument;
  468. var
  469. HTMLEl: THTMLHtmlElement;
  470. HeadEl: THTMLHeadElement;
  471. El: TDOMElement;
  472. begin
  473. Doc := THTMLDocument.Create;
  474. Result := Doc;
  475. Doc.AppendChild(Doc.CreateProcessingInstruction(
  476. 'DOCTYPE', 'HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"'));
  477. HTMLEl := Doc.CreateHtmlElement;
  478. Doc.AppendChild(HTMLEl);
  479. HeadEl := Doc.CreateHeadElement;
  480. HTMLEl.AppendChild(HeadEl);
  481. El := Doc.CreateElement('meta');
  482. HeadEl.AppendChild(El);
  483. El['http-equiv'] := 'Content-Type';
  484. El['content'] := 'text/html; charset=iso-8859-1';
  485. TitleElement := Doc.CreateElement('title');
  486. HeadEl.AppendChild(TitleElement);
  487. El := Doc.CreateElement('link');
  488. BodyElement := Doc.CreateElement('body');
  489. HTMLEl.AppendChild(BodyElement);
  490. CreatePageBody(AElement, ASubpageIndex);
  491. AppendFooter;
  492. HeadEl.AppendChild(El);
  493. El['rel'] := 'stylesheet';
  494. El['type'] := 'text/css';
  495. El['href'] := FixHtmlPath(Allocator.GetCSSFilename(AElement));
  496. end;
  497. function THTMLWriter.CreateXHTMLPage(AElement: TPasElement;
  498. ASubpageIndex: Integer): TXMLDocument;
  499. begin
  500. Result := nil;
  501. end;
  502. procedure CreatePath(const AFilename: String);
  503. var
  504. EndIndex: Integer;
  505. Path: String;
  506. begin
  507. EndIndex := Length(AFilename);
  508. if EndIndex = 0 then
  509. exit;
  510. while not (AFilename[EndIndex] in DirSeparators) do
  511. begin
  512. Dec(EndIndex);
  513. if EndIndex = 0 then
  514. exit;
  515. end;
  516. Path := Copy(AFilename, 1, EndIndex - 1);
  517. if not FileExists(Path) then
  518. begin
  519. CreatePath(Path);
  520. MkDir(Path);
  521. end;
  522. end;
  523. procedure THTMLWriter.WriteHTMLPages;
  524. var
  525. i: Integer;
  526. PageDoc: TXMLDocument;
  527. Filename: String;
  528. begin
  529. if Engine.Output <> '' then
  530. Engine.Output := IncludeTrailingBackSlash(Engine.Output);
  531. for i := 0 to PageInfos.Count - 1 do
  532. with TPageInfo(PageInfos[i]) do
  533. begin
  534. PageDoc := CreateHTMLPage(Element, SubpageIndex);
  535. try
  536. Filename := Engine.Output + Allocator.GetFilename(Element, SubpageIndex);
  537. CreatePath(Filename);
  538. WriteHTMLFile(PageDoc, Filename);
  539. finally
  540. PageDoc.Free;
  541. end;
  542. end;
  543. end;
  544. procedure THTMLWriter.WriteXHTMLPages;
  545. begin
  546. end;
  547. {procedure THTMLWriter.CreateDoc(const ATitle: DOMString;
  548. AElement: TPasElement; const AFilename: String);
  549. var
  550. El: TDOMElement;
  551. DocInfo: TDocInfo;
  552. CSSName: String;
  553. begin
  554. Doc := TXHTMLDocument.Create;
  555. with TXHTMLDocument(Doc) do
  556. begin
  557. Encoding := 'ISO8859-1';
  558. CSSName := 'fpdoc.css';
  559. if Assigned(Module) then
  560. CSSName := '../' + CSSName;
  561. $IFNDEF ver1_0
  562. StylesheetType := 'text/css';
  563. StylesheetHRef := CSSName;
  564. $ENDIF
  565. CreateRoot(xhtmlStrict);
  566. with RequestHeadElement do
  567. begin
  568. AppendText(RequestTitleElement, ATitle);
  569. El := CreateElement('link');
  570. AppendChild(El);
  571. El['rel'] := 'stylesheet';
  572. El['type'] := 'text/css';
  573. El['href'] := FixHtmlPath(CSSName);
  574. end;
  575. Self.BodyElement := RequestBodyElement('en');
  576. end;
  577. if Length(AFilename) > 0 then
  578. begin
  579. DocInfo := TDocInfo.Create;
  580. DocInfos.Add(DocInfo);
  581. DocInfo.Element := AElement;
  582. DocInfo.Filename := AFilename;
  583. end;
  584. end;
  585. }
  586. { Used for:
  587. - <link> elements in descriptions
  588. - "see also" entries
  589. - AppendHyperlink (for unresolved parse tree element links)
  590. }
  591. function THTMLWriter.ResolveLinkID(const Name: String): DOMString;
  592. var
  593. i: Integer;
  594. ThisPackage: TLinkNode;
  595. begin
  596. if Length(Name) = 0 then
  597. begin
  598. SetLength(Result, 0);
  599. exit;
  600. end;
  601. if Name[1] = '#' then
  602. Result := Engine.FindAbsoluteLink(Name)
  603. else
  604. begin
  605. SetLength(Result, 0);
  606. { Try all packages }
  607. ThisPackage := Engine.RootLinkNode.FirstChild;
  608. while Assigned(ThisPackage) do
  609. begin
  610. Result := Engine.FindAbsoluteLink(ThisPackage.Name + '.' + Name);
  611. if Length(Result) = 0 then
  612. begin
  613. if Assigned(Module) then
  614. Result := Engine.FindAbsoluteLink(Module.PathName + '.' + Name);
  615. // WriteLn('Searching for ', Module.PathName + '.' + Name, ' => ', Result);
  616. if Length(Result) = 0 then
  617. for i := Length(Name) downto 1 do
  618. if Name[i] = '.' then
  619. begin
  620. Result := ResolveLinkID(Copy(Name, 1, i - 1));
  621. exit;
  622. end;
  623. end;
  624. ThisPackage := ThisPackage.NextSibling;
  625. end;
  626. end;
  627. if Length(Result) > 0 then
  628. if Copy(Result, 1, Length(CurDirectory) + 1) = CurDirectory + '/' then
  629. Result := Copy(Result, Length(CurDirectory) + 2, Length(Result))
  630. else
  631. Result := BaseDirectory + Result;
  632. end;
  633. function THTMLWriter.ResolveLinkWithinPackage(AElement: TPasElement;
  634. ASubpageIndex: Integer): String;
  635. var
  636. ParentEl: TPasElement;
  637. begin
  638. ParentEl := AElement;
  639. while Assigned(ParentEl) and not (ParentEl.ClassType = TPasPackage) do
  640. ParentEl := ParentEl.Parent;
  641. if Assigned(ParentEl) and (TPasPackage(ParentEl) = Engine.Package) then
  642. begin
  643. Result := Allocator.GetFilename(AElement, ASubpageIndex);
  644. if Copy(Result, 1, Length(CurDirectory) + 1) = CurDirectory + '/' then
  645. Result := Copy(Result, Length(CurDirectory) + 2, Length(Result))
  646. else
  647. Result := BaseDirectory + Result;
  648. end else
  649. SetLength(Result, 0);
  650. end;
  651. function THTMLWriter.CreateEl(Parent: TDOMNode;
  652. const AName: DOMString): THTMLElement;
  653. begin
  654. Result := Doc.CreateElement(AName);
  655. Parent.AppendChild(Result);
  656. end;
  657. function THTMLWriter.CreatePara(Parent: TDOMNode): THTMLElement;
  658. begin
  659. Result := CreateEl(Parent, 'p');
  660. end;
  661. function THTMLWriter.CreateH1(Parent: TDOMNode): THTMLElement;
  662. begin
  663. Result := CreateEl(Parent, 'h1');
  664. end;
  665. function THTMLWriter.CreateH2(Parent: TDOMNode): THTMLElement;
  666. begin
  667. Result := CreateEl(Parent, 'h2');
  668. end;
  669. function THTMLWriter.CreateH3(Parent: TDOMNode): THTMLElement;
  670. begin
  671. Result := CreateEl(Parent, 'h3');
  672. end;
  673. function THTMLWriter.CreateTable(Parent: TDOMNode): THTMLElement;
  674. begin
  675. Result := CreateEl(Parent, 'table');
  676. Result['cellspacing'] := '0';
  677. Result['cellpadding'] := '0';
  678. end;
  679. function THTMLWriter.CreateContentTable(Parent: TDOMNode): THTMLElement;
  680. begin
  681. Result := CreateEl(Parent, 'table');
  682. end;
  683. function THTMLWriter.CreateTR(Parent: TDOMNode): THTMLElement;
  684. begin
  685. Result := CreateEl(Parent, 'tr');
  686. end;
  687. function THTMLWriter.CreateTD(Parent: TDOMNode): THTMLElement;
  688. begin
  689. Result := CreateEl(Parent, 'td');
  690. end;
  691. function THTMLWriter.CreateTD_vtop(Parent: TDOMNode): THTMLElement;
  692. begin
  693. Result := CreateEl(Parent, 'td');
  694. Result['valign'] := 'top';
  695. end;
  696. function THTMLWriter.CreateLink(Parent: TDOMNode;
  697. const AHRef: DOMString): THTMLElement;
  698. begin
  699. Result := CreateEl(Parent, 'a');
  700. Result['href'] := FixHtmlPath(AHRef);
  701. end;
  702. function THTMLWriter.CreateAnchor(Parent: TDOMNode;
  703. const AName: DOMString): THTMLElement;
  704. begin
  705. Result := CreateEl(Parent, 'a');
  706. Result['name'] := AName;
  707. end;
  708. function THTMLWriter.CreateCode(Parent: TDOMNode): THTMLElement;
  709. begin
  710. Result := CreateEl(CreateEl(Parent, 'tt'), 'span');
  711. Result['class'] := 'code';
  712. end;
  713. function THTMLWriter.CreateWarning(Parent: TDOMNode): THTMLElement;
  714. begin
  715. Result := CreateEl(Parent, 'span');
  716. Result['class'] := 'warning';
  717. end;
  718. procedure THTMLWriter.PushOutputNode(ANode: TDOMNode);
  719. begin
  720. OutputNodeStack.Add(CurOutputNode);
  721. CurOutputNode := ANode;
  722. end;
  723. procedure THTMLWriter.PopOutputNode;
  724. begin
  725. CurOutputNode := TDOMNode(OutputNodeStack[OutputNodeStack.Count - 1]);
  726. OutputNodeStack.Delete(OutputNodeStack.Count - 1);
  727. end;
  728. procedure THTMLWriter.DescrWriteText(const AText: DOMString);
  729. begin
  730. AppendText(CurOutputNode, AText);
  731. end;
  732. procedure THTMLWriter.DescrBeginBold;
  733. begin
  734. PushOutputNode(CreateEl(CurOutputNode, 'b'));
  735. end;
  736. procedure THTMLWriter.DescrEndBold;
  737. begin
  738. PopOutputNode;
  739. end;
  740. procedure THTMLWriter.DescrBeginItalic;
  741. begin
  742. PushOutputNode(CreateEl(CurOutputNode, 'i'));
  743. end;
  744. procedure THTMLWriter.DescrEndItalic;
  745. begin
  746. PopOutputNode;
  747. end;
  748. procedure THTMLWriter.DescrBeginEmph;
  749. begin
  750. PushOutputNode(CreateEl(CurOutputNode, 'em'));
  751. end;
  752. procedure THTMLWriter.DescrEndEmph;
  753. begin
  754. PopOutputNode;
  755. end;
  756. procedure THTMLWriter.DescrWriteFileEl(const AText: DOMString);
  757. var
  758. NewEl: TDOMElement;
  759. begin
  760. NewEl := CreateEl(CurOutputNode, 'span');
  761. NewEl['class'] := 'file';
  762. AppendText(NewEl, AText);
  763. end;
  764. procedure THTMLWriter.DescrWriteKeywordEl(const AText: DOMString);
  765. var
  766. NewEl: TDOMElement;
  767. begin
  768. NewEl := CreateEl(CurOutputNode, 'span');
  769. NewEl['class'] := 'kw';
  770. AppendText(NewEl, AText);
  771. end;
  772. procedure THTMLWriter.DescrWriteVarEl(const AText: DOMString);
  773. begin
  774. AppendText(CreateEl(CurOutputNode, 'var'), AText);
  775. end;
  776. procedure THTMLWriter.DescrBeginLink(const AId: DOMString);
  777. var
  778. a,s: String;
  779. begin
  780. a:=AId;
  781. s := ResolveLinkID(a);
  782. if Length(s) = 0 then
  783. begin
  784. WriteLn(Format(SErrUnknownLinkID, [a]));
  785. PushOutputNode(CreateEl(CurOutputNode, 'b'));
  786. end else
  787. PushOutputNode(CreateLink(CurOutputNode, s));
  788. end;
  789. procedure THTMLWriter.DescrEndLink;
  790. begin
  791. PopOutputNode;
  792. end;
  793. procedure THTMLWriter.DescrWriteLinebreak;
  794. begin
  795. CreateEl(CurOutputNode, 'br');
  796. end;
  797. procedure THTMLWriter.DescrBeginParagraph;
  798. begin
  799. PushOutputNode(CreatePara(CurOutputNode));
  800. end;
  801. procedure THTMLWriter.DescrEndParagraph;
  802. begin
  803. PopOutputNode;
  804. end;
  805. procedure THTMLWriter.DescrBeginCode(HasBorder: Boolean; const AHighlighterName: String);
  806. begin
  807. DoPasHighlighting := (AHighlighterName = '') or (AHighlighterName = 'Pascal');
  808. HighlighterFlags := 0;
  809. PushOutputNode(CreateEl(CurOutputNode, 'pre'));
  810. end;
  811. procedure THTMLWriter.DescrWriteCodeLine(const ALine: String);
  812. begin
  813. if DoPasHighlighting then
  814. begin
  815. HighlighterFlags := AppendPasSHFragment(CurOutputNode, ALine,
  816. HighlighterFlags);
  817. AppendText(CurOutputNode, #10);
  818. end else
  819. AppendText(CurOutputNode, ALine + #10);
  820. end;
  821. procedure THTMLWriter.DescrEndCode;
  822. begin
  823. PopOutputNode;
  824. end;
  825. procedure THTMLWriter.DescrBeginOrderedList;
  826. begin
  827. PushOutputNode(CreateEl(CurOutputNode, 'ol'));
  828. end;
  829. procedure THTMLWriter.DescrEndOrderedList;
  830. begin
  831. PopOutputNode;
  832. end;
  833. procedure THTMLWriter.DescrBeginUnorderedList;
  834. begin
  835. PushOutputNode(CreateEl(CurOutputNode, 'ul'));
  836. end;
  837. procedure THTMLWriter.DescrEndUnorderedList;
  838. begin
  839. PopOutputNode;
  840. end;
  841. procedure THTMLWriter.DescrBeginDefinitionList;
  842. begin
  843. PushOutputNode(CreateEl(CurOutputNode, 'dl'));
  844. end;
  845. procedure THTMLWriter.DescrEndDefinitionList;
  846. begin
  847. PopOutputNode;
  848. end;
  849. procedure THTMLWriter.DescrBeginListItem;
  850. begin
  851. PushOutputNode(CreateEl(CurOutputNode, 'li'));
  852. end;
  853. procedure THTMLWriter.DescrEndListItem;
  854. begin
  855. PopOutputNode;
  856. end;
  857. procedure THTMLWriter.DescrBeginDefinitionTerm;
  858. begin
  859. PushOutputNode(CreateEl(CurOutputNode, 'dt'));
  860. end;
  861. procedure THTMLWriter.DescrEndDefinitionTerm;
  862. begin
  863. PopOutputNode;
  864. end;
  865. procedure THTMLWriter.DescrBeginDefinitionEntry;
  866. begin
  867. PushOutputNode(CreateEl(CurOutputNode, 'dd'));
  868. end;
  869. procedure THTMLWriter.DescrEndDefinitionEntry;
  870. begin
  871. PopOutputNode;
  872. end;
  873. procedure THTMLWriter.DescrBeginSectionTitle;
  874. begin
  875. PushOutputNode(CreateEl(CurOutputNode, 'h3'));
  876. end;
  877. procedure THTMLWriter.DescrBeginSectionBody;
  878. begin
  879. PopOutputNode;
  880. end;
  881. procedure THTMLWriter.DescrEndSection;
  882. begin
  883. end;
  884. procedure THTMLWriter.DescrBeginRemark;
  885. var
  886. NewEl, TDEl: TDOMElement;
  887. begin
  888. NewEl := CreateEl(CurOutputNode, 'table');
  889. NewEl['width'] := '100%';
  890. NewEl['border'] := '0';
  891. NewEl['CellSpacing'] := '0';
  892. NewEl['class'] := 'remark';
  893. NewEl := CreateTR(NewEl);
  894. TDEl := CreateTD(NewEl);
  895. TDEl['valign'] := 'top';
  896. TDEl['class'] := 'pre';
  897. AppendText(CreateEl(TDEl, 'b'), SDocRemark);
  898. PushOutputNode(CreateTD(NewEl));
  899. end;
  900. procedure THTMLWriter.DescrEndRemark;
  901. begin
  902. PopOutputNode;
  903. end;
  904. procedure THTMLWriter.DescrBeginTable(ColCount: Integer; HasBorder: Boolean);
  905. var
  906. Table: TDOMElement;
  907. begin
  908. Table := CreateEl(CurOutputNode, 'table');
  909. Table['border'] := IntToStr(Ord(HasBorder));
  910. PushOutputNode(Table);
  911. end;
  912. procedure THTMLWriter.DescrEndTable;
  913. begin
  914. PopOutputNode;
  915. end;
  916. procedure THTMLWriter.DescrBeginTableCaption;
  917. begin
  918. PushOutputNode(CreateEl(CurOutputNode, 'caption'));
  919. end;
  920. procedure THTMLWriter.DescrEndTableCaption;
  921. begin
  922. PopOutputNode;
  923. end;
  924. procedure THTMLWriter.DescrBeginTableHeadRow;
  925. begin
  926. PushOutputNode(CreateTr(CurOutputNode));
  927. InsideHeadRow := True;
  928. end;
  929. procedure THTMLWriter.DescrEndTableHeadRow;
  930. begin
  931. InsideHeadRow := False;
  932. PopOutputNode;
  933. end;
  934. procedure THTMLWriter.DescrBeginTableRow;
  935. begin
  936. PushOutputNode(CreateTR(CurOutputNode));
  937. end;
  938. procedure THTMLWriter.DescrEndTableRow;
  939. begin
  940. PopOutputNode;
  941. end;
  942. procedure THTMLWriter.DescrBeginTableCell;
  943. begin
  944. if InsideHeadRow then
  945. PushOutputNode(CreateEl(CurOutputNode, 'th'))
  946. else
  947. PushOutputNode(CreateTD(CurOutputNode));
  948. end;
  949. procedure THTMLWriter.DescrEndTableCell;
  950. begin
  951. PopOutputNode;
  952. end;
  953. procedure THTMLWriter.AppendText(Parent: TDOMNode; const AText: DOMString);
  954. begin
  955. Parent.AppendChild(Doc.CreateTextNode(AText));
  956. end;
  957. procedure THTMLWriter.AppendNbSp(Parent: TDOMNode; ACount: Integer);
  958. begin
  959. while ACount > 0 do
  960. begin
  961. Parent.AppendChild(Doc.CreateEntityReference('nbsp'));
  962. Dec(ACount);
  963. end;
  964. end;
  965. procedure THTMLWriter.AppendSym(Parent: TDOMNode; const AText: DOMString);
  966. var
  967. El: TDOMElement;
  968. begin
  969. El := CreateEl(Parent, 'span');
  970. El['class'] := 'sym';
  971. AppendText(El, AText);
  972. end;
  973. procedure THTMLWriter.AppendKw(Parent: TDOMNode; const AText: DOMString);
  974. var
  975. El: TDOMElement;
  976. begin
  977. El := CreateEl(Parent, 'span');
  978. El['class'] := 'kw';
  979. AppendText(El, AText);
  980. end;
  981. function THTMLWriter.AppendPasSHFragment(Parent: TDOMNode;
  982. const AText: String; AShFlags: Byte): Byte;
  983. var
  984. CurParent: TDOMNode;
  985. Line, Last, p: PChar;
  986. IsInSpecial: Boolean;
  987. El: TDOMElement;
  988. begin
  989. GetMem(Line, Length(AText) * 3 + 4);
  990. DoPascalHighlighting(AShFlags, PChar(AText), Line);
  991. Result := AShFlags;
  992. CurParent := Parent;
  993. IsInSpecial := False;
  994. Last := Line;
  995. p := Line;
  996. while p[0] <> #0 do
  997. begin
  998. if p[0] = LF_ESCAPE then
  999. begin
  1000. p[0] := #0;
  1001. AppendText(CurParent, Last);
  1002. if IsInSpecial then
  1003. CurParent := Parent;
  1004. case Ord(p[1]) of
  1005. shDefault:
  1006. IsInSpecial := False;
  1007. shInvalid:
  1008. begin
  1009. El := CreateEl(CurParent, 'font');
  1010. El['color'] := 'red';
  1011. CurParent := El;
  1012. IsInSpecial := True;
  1013. end;
  1014. shSymbol:
  1015. begin
  1016. El := CreateEl(CurParent, 'span');
  1017. El['class'] := 'sym';
  1018. CurParent := El;
  1019. IsInSpecial := True;
  1020. end;
  1021. shKeyword:
  1022. begin
  1023. El := CreateEl(CurParent, 'span');
  1024. El['class'] := 'kw';
  1025. CurParent := El;
  1026. IsInSpecial := True;
  1027. end;
  1028. shComment:
  1029. begin
  1030. El := CreateEl(CurParent, 'span');
  1031. El['class'] := 'cmt';
  1032. CurParent := El;
  1033. IsInSpecial := True;
  1034. end;
  1035. shDirective:
  1036. begin
  1037. El := CreateEl(CurParent, 'span');
  1038. El['class'] := 'dir';
  1039. CurParent := El;
  1040. IsInSpecial := True;
  1041. end;
  1042. shNumbers:
  1043. begin
  1044. El := CreateEl(CurParent, 'span');
  1045. El['class'] := 'num';
  1046. CurParent := El;
  1047. IsInSpecial := True;
  1048. end;
  1049. shCharacters:
  1050. begin
  1051. El := CreateEl(CurParent, 'span');
  1052. El['class'] := 'chr';
  1053. CurParent := El;
  1054. IsInSpecial := True;
  1055. end;
  1056. shStrings:
  1057. begin
  1058. El := CreateEl(CurParent, 'span');
  1059. El['class'] := 'str';
  1060. CurParent := El;
  1061. IsInSpecial := True;
  1062. end;
  1063. shAssembler:
  1064. begin
  1065. El := CreateEl(CurParent, 'span');
  1066. El['class'] := 'asm';
  1067. CurParent := El;
  1068. IsInSpecial := True;
  1069. end;
  1070. end;
  1071. Last := p + 2;
  1072. end;
  1073. Inc(p);
  1074. end;
  1075. if Last <> p then
  1076. AppendText(CurParent, Last);
  1077. FreeMem(Line);
  1078. end;
  1079. Procedure THTMLWriter.AppendShortDescr(AContext: TPasElement; Parent: TDOMNode; DocNode : TDocNode);
  1080. begin
  1081. if Assigned(DocNode) and Assigned(DocNode.ShortDescr) then
  1082. begin
  1083. PushOutputNode(Parent);
  1084. try
  1085. if not ConvertShort(AContext,TDomElement(DocNode.ShortDescr)) then
  1086. WriteLn(SErrInvalidShortDescr);
  1087. finally
  1088. PopOutputNode;
  1089. end;
  1090. end;
  1091. end;
  1092. procedure THTMLWriter.AppendShortDescr(Parent: TDOMNode; Element: TPasElement);
  1093. begin
  1094. AppendShortDescr(Element,Parent,Engine.FindDocNode(Element));
  1095. end;
  1096. procedure THTMLWriter.AppendDescr(AContext: TPasElement; Parent: TDOMNode;
  1097. DescrNode: TDOMElement; AutoInsertBlock: Boolean);
  1098. begin
  1099. if Assigned(DescrNode) then
  1100. begin
  1101. PushOutputNode(Parent);
  1102. try
  1103. ConvertDescr(AContext, DescrNode, AutoInsertBlock);
  1104. finally
  1105. PopOutputNode;
  1106. end;
  1107. end;
  1108. end;
  1109. procedure THTMLWriter.AppendDescrSection(AContext: TPasElement;
  1110. Parent: TDOMNode; DescrNode: TDOMElement; const ATitle: DOMString);
  1111. begin
  1112. if not IsDescrNodeEmpty(DescrNode) then
  1113. begin
  1114. If (ATitle<>'') then // Can be empty for topic.
  1115. AppendText(CreateH2(Parent), ATitle);
  1116. AppendDescr(AContext, Parent, DescrNode, True);
  1117. end;
  1118. end;
  1119. procedure THTMLWriter.AppendShortDescrCell(Parent: TDOMNode;
  1120. Element: TPasElement);
  1121. var
  1122. ParaEl: TDOMElement;
  1123. begin
  1124. if Assigned(Engine.FindShortDescr(Element)) then
  1125. begin
  1126. AppendNbSp(CreatePara(CreateTD(Parent)), 2);
  1127. ParaEl := CreatePara(CreateTD(Parent));
  1128. ParaEl['class'] := 'cmt';
  1129. AppendShortDescr(ParaEl, Element);
  1130. end;
  1131. end;
  1132. function THTMLWriter.AppendHyperlink(Parent: TDOMNode;
  1133. Element: TPasElement): TDOMElement;
  1134. var
  1135. s: String;
  1136. UnitList: TList;
  1137. i: Integer;
  1138. ThisPackage: TLinkNode;
  1139. begin
  1140. if Assigned(Element) then
  1141. begin
  1142. if Element.InheritsFrom(TPasUnresolvedTypeRef) then
  1143. begin
  1144. s := ResolveLinkID(Element.Name);
  1145. if Length(s) = 0 then
  1146. begin
  1147. { Try all packages }
  1148. ThisPackage := Engine.RootLinkNode.FirstChild;
  1149. while Assigned(ThisPackage) do
  1150. begin
  1151. s := ResolveLinkID(ThisPackage.Name + '.' + Element.Name);
  1152. if Length(s) > 0 then
  1153. break;
  1154. ThisPackage := ThisPackage.NextSibling;
  1155. end;
  1156. if Length(s) = 0 then
  1157. begin
  1158. { Okay, then we have to try all imported units of the current module }
  1159. UnitList := Module.InterfaceSection.UsesList;
  1160. for i := UnitList.Count - 1 downto 0 do
  1161. begin
  1162. { Try all packages }
  1163. ThisPackage := Engine.RootLinkNode.FirstChild;
  1164. while Assigned(ThisPackage) do
  1165. begin
  1166. s := ResolveLinkID(ThisPackage.Name + '.' +
  1167. TPasType(UnitList[i]).Name + '.' + Element.Name);
  1168. if Length(s) > 0 then
  1169. break;
  1170. ThisPackage := ThisPackage.NextSibling;
  1171. end;
  1172. if Length(s) > 0 then
  1173. break;
  1174. end;
  1175. end;
  1176. end;
  1177. end else
  1178. s := ResolveLinkID(Element.PathName);
  1179. if Length(s) > 0 then
  1180. begin
  1181. Result := CreateLink(Parent, s);
  1182. AppendText(Result, Element.Name);
  1183. end else
  1184. begin
  1185. Result := nil;
  1186. AppendText(Parent, Element.Name);
  1187. end;
  1188. end else
  1189. begin
  1190. Result := nil;
  1191. AppendText(CreateWarning(Parent), '<NIL>');
  1192. end;
  1193. end;
  1194. { Returns the new CodeEl, which will be the old CodeEl in most cases }
  1195. function THTMLWriter.AppendType(CodeEl, TableEl: TDOMElement;
  1196. Element: TPasType; Expanded: Boolean; NestingLevel: Integer): TDOMElement;
  1197. begin
  1198. Result := CodeEl;
  1199. if not Assigned(Element) then
  1200. AppendText(CreateWarning(CodeEl), '<NIL>')
  1201. else if (not Expanded) and (Length(Element.Name) > 0) then
  1202. AppendHyperlink(CodeEl, Element)
  1203. else
  1204. // Array
  1205. if Element.ClassType = TPasArrayType then
  1206. begin
  1207. AppendPasSHFragment(CodeEl,
  1208. 'array [' + TPasArrayType(Element).IndexRange + '] of ', 0);
  1209. Result := AppendType(CodeEl, TableEl, TPasArrayType(Element).ElType, False);
  1210. end else
  1211. // Procedure or funtion type
  1212. if Element.InheritsFrom(TPasProcedureType) then
  1213. begin
  1214. AppendKw(CodeEl, TPasProcedureType(Element).TypeName);
  1215. Result := AppendProcType(CodeEl, TableEl, TPasProcedureType(Element), 0)
  1216. end else
  1217. // Range type
  1218. if Element.InheritsFrom(TPasRangeType) then
  1219. AppendPasSHFragment(CodeEl, TPasRangeType(Element).RangeStart + '..' +
  1220. TPasRangeType(Element).RangeEnd, 0)
  1221. // Record type
  1222. else if Element.ClassType = TPasRecordType then
  1223. Result := AppendRecordType(CodeEl, TableEl, TPasRecordType(Element), NestingLevel)
  1224. else
  1225. // Other types
  1226. AppendHyperlink(CodeEl, Element);
  1227. end;
  1228. function THTMLWriter.AppendProcType(CodeEl, TableEl: TDOMElement;
  1229. Element: TPasProcedureType; Indent: Integer): TDOMElement;
  1230. function CreateIndentedCodeEl(Indent: Integer): TDOMElement;
  1231. begin
  1232. Result := CreateCode(CreatePara(CreateTD(CreateTR(TableEl))));
  1233. AppendNbSp(Result, Indent);
  1234. end;
  1235. var
  1236. i: Integer;
  1237. Arg: TPasArgument;
  1238. begin
  1239. if Element.Args.Count > 0 then
  1240. begin
  1241. AppendSym(CodeEl, '(');
  1242. for i := 0 to Element.Args.Count - 1 do
  1243. begin
  1244. Arg := TPasArgument(Element.Args[i]);
  1245. CodeEl := CreateIndentedCodeEl(Indent + 2);
  1246. case Arg.Access of
  1247. argConst: AppendKw(CodeEl, 'const ');
  1248. argVar: AppendKw(CodeEl, 'var ');
  1249. argOut: AppendKw(CodeEl, 'out ');
  1250. end;
  1251. AppendText(CodeEl, Arg.Name);
  1252. if Assigned(Arg.ArgType) then
  1253. begin
  1254. AppendSym(CodeEl, ': ');
  1255. CodeEl := AppendType(CodeEl, TableEl, Arg.ArgType, False);
  1256. end;
  1257. if Length(Arg.Value) > 0 then
  1258. AppendPasSHFragment(CodeEl, ' = ' + Arg.Value, 0);
  1259. if i < Element.Args.Count - 1 then
  1260. AppendSym(CodeEl, ';');
  1261. end;
  1262. if Element.InheritsFrom(TPasFunctionType) or Element.IsOfObject then
  1263. begin
  1264. CodeEl := CreateIndentedCodeEl(Indent);
  1265. if Element.InheritsFrom(TPasFunctionType) then
  1266. begin
  1267. AppendSym(CodeEl, '):');
  1268. AppendHyperlink(CodeEl, TPasFunctionType(Element).ResultEl.ResultType);
  1269. end else
  1270. AppendSym(CodeEl, ')');
  1271. if Element.IsOfObject then
  1272. begin
  1273. AppendText(CodeEl, ' '); // Don't remove
  1274. AppendKw(CodeEl, 'of object');
  1275. end;
  1276. end else
  1277. if Indent > 0 then
  1278. AppendSym(CodeEl, ')')
  1279. else
  1280. begin
  1281. CodeEl := CreateCode(CreatePara(CreateTD(CreateTR(TableEl))));
  1282. AppendSym(CodeEl, ')');
  1283. end;
  1284. end else
  1285. begin
  1286. { Procedure or function without arguments }
  1287. if Element.InheritsFrom(TPasFunctionType) then
  1288. begin
  1289. AppendSym(CodeEl, ': ');
  1290. AppendHyperlink(CodeEl, TPasFunctionType(Element).ResultEl.ResultType);
  1291. end;
  1292. if Element.IsOfObject then
  1293. AppendKw(CodeEl, ' of object');
  1294. end;
  1295. Result := CodeEl;
  1296. end;
  1297. procedure THTMLWriter.AppendProcExt(CodeEl: TDOMElement;
  1298. Element: TPasProcedure);
  1299. procedure AppendExt(const Ext: String);
  1300. begin
  1301. AppendKw(CodeEl, ' ' + Ext);
  1302. AppendSym(CodeEl, ';');
  1303. end;
  1304. begin
  1305. if Element.IsVirtual then
  1306. AppendExt('virtual');
  1307. if Element.IsDynamic then
  1308. AppendExt('dynamic');
  1309. if Element.IsAbstract then
  1310. AppendExt('abstract');
  1311. if Element.IsOverride then
  1312. AppendExt('override');
  1313. if Element.IsOverload then
  1314. AppendExt('overload');
  1315. if Element.IsMessage then
  1316. AppendExt('message');
  1317. end;
  1318. { Used in two places:
  1319. - Page for the method of a class
  1320. - Page for a tandalone procedure or function. }
  1321. procedure THTMLWriter.AppendProcDecl(CodeEl, TableEl: TDOMElement;
  1322. Element: TPasProcedureBase);
  1323. procedure WriteVariant(AProc: TPasProcedure);
  1324. begin
  1325. AppendProcArgsSection(TableEl.ParentNode, AProc.ProcType);
  1326. AppendKw(CodeEl, AProc.TypeName);
  1327. if Element.Parent.ClassType = TPasClassType then
  1328. begin
  1329. AppendText(CodeEl, ' ');
  1330. AppendHyperlink(CodeEl, Element.Parent);
  1331. AppendSym(CodeEl, '.');
  1332. AppendText(CodeEl, AProc.Name);
  1333. end else
  1334. AppendText(CodeEl, ' ' + AProc.FullName);
  1335. CodeEl := AppendProcType(CodeEl, TableEl, AProc.ProcType, 0);
  1336. AppendSym(CodeEl, ';');
  1337. AppendProcExt(CodeEl, AProc);
  1338. end;
  1339. var
  1340. i: Integer;
  1341. begin
  1342. if Element.ClassType = TPasOverloadedProc then
  1343. for i := 0 to TPasOverloadedProc(Element).Overloads.Count - 1 do
  1344. begin
  1345. if i > 0 then
  1346. begin
  1347. CreateEl(CodeEl, 'br');
  1348. CreateEl(CodeEl, 'br');
  1349. end;
  1350. WriteVariant(TPasProcedure(TPasOverloadedProc(Element).Overloads[i]));
  1351. end
  1352. else
  1353. WriteVariant(TPasProcedure(Element));
  1354. end;
  1355. procedure THTMLWriter.AppendProcArgsSection(Parent: TDOMNode;
  1356. Element: TPasProcedureType);
  1357. var
  1358. HasFullDescr, IsFirst: Boolean;
  1359. ResultEl: TPasResultElement;
  1360. ArgTableEl, TREl: TDOMElement;
  1361. DocNode: TDocNode;
  1362. i: Integer;
  1363. Arg: TPasArgument;
  1364. begin
  1365. IsFirst := True;
  1366. for i := 0 to Element.Args.Count - 1 do
  1367. begin
  1368. Arg := TPasArgument(Element.Args[i]);
  1369. if IsDescrNodeEmpty(Engine.FindShortDescr(Arg)) then
  1370. continue;
  1371. if IsFirst then
  1372. begin
  1373. IsFirst := False;
  1374. AppendText(CreateH2(Parent), SDocArguments);
  1375. ArgTableEl := CreateTable(Parent);
  1376. end;
  1377. TREl := CreateTR(ArgTableEl);
  1378. AppendText(CreateCode(CreatePara(CreateTD_vtop(TREl))), Arg.Name);
  1379. AppendShortDescrCell(TREl, Arg);
  1380. end;
  1381. if Element.ClassType = TPasFunctionType then
  1382. begin
  1383. ResultEl := TPasFunctionType(Element).ResultEl;
  1384. DocNode := Engine.FindDocNode(ResultEl);
  1385. HasFullDescr := Assigned(DocNode) and not IsDescrNodeEmpty(DocNode.Descr);
  1386. if HasFullDescr or
  1387. (Assigned(DocNode) and not IsDescrNodeEmpty(DocNode.ShortDescr)) then
  1388. begin
  1389. AppendText(CreateH2(Parent), SDocFunctionResult);
  1390. if HasFullDescr then
  1391. AppendDescr(ResultEl, Parent, DocNode.Descr, True)
  1392. else
  1393. AppendDescr(ResultEl, CreatePara(Parent), DocNode.ShortDescr, False);
  1394. end;
  1395. end;
  1396. end;
  1397. function THTMLWriter.AppendRecordType(CodeEl, TableEl: TDOMElement;
  1398. Element: TPasRecordType; NestingLevel: Integer): TDOMElement;
  1399. var
  1400. i, j: Integer;
  1401. Variable: TPasVariable;
  1402. TREl, TDEl: TDOMElement;
  1403. CurVariant: TPasVariant;
  1404. begin
  1405. if not (Element.Parent is TPasVariant) then
  1406. if Element.IsPacked then
  1407. AppendKw(CodeEl, 'packed record')
  1408. else
  1409. AppendKw(CodeEl, 'record');
  1410. for i := 0 to Element.Members.Count - 1 do
  1411. begin
  1412. Variable := TPasVariable(Element.Members[i]);
  1413. TREl := CreateTR(TableEl);
  1414. CodeEl := CreateCode(CreatePara(CreateTD_vtop(TREl)));
  1415. AppendShortDescrCell(TREl, Variable);
  1416. AppendNbSp(CodeEl, NestingLevel * 2 + 2);
  1417. AppendText(CodeEl, Variable.Name);
  1418. AppendSym(CodeEl, ': ');
  1419. CodeEl := AppendType(CodeEl, TableEl, Variable.VarType, False, NestingLevel + 1);
  1420. AppendSym(CodeEl, ';');
  1421. end;
  1422. if Assigned(Element.VariantType) then
  1423. begin
  1424. TREl := CreateTR(TableEl);
  1425. CodeEl := CreateCode(CreatePara(CreateTD_vtop(TREl)));
  1426. AppendNbSp(CodeEl, NestingLevel * 2 + 2);
  1427. AppendKw(CodeEl, 'case ');
  1428. if TPasRecordType(Element).VariantName <> '' then
  1429. begin
  1430. AppendText(CodeEl, TPasRecordType(Element).VariantName);
  1431. AppendSym(CodeEl, ': ');
  1432. end;
  1433. CodeEl := AppendType(CodeEl, TableEl, TPasRecordType(Element).VariantType, True);
  1434. AppendKw(CodeEl, ' of');
  1435. for i := 0 to TPasRecordType(Element).Variants.Count - 1 do
  1436. begin
  1437. CurVariant := TPasVariant(Element.Variants[i]);
  1438. TREl := CreateTR(TableEl);
  1439. CodeEl := CreateCode(CreatePara(CreateTD_vtop(TREl)));
  1440. AppendNbSp(CodeEl, NestingLevel * 2 + 4);
  1441. for j := 0 to CurVariant.Values.Count - 1 do
  1442. begin
  1443. if j > 0 then
  1444. AppendSym(CodeEl, ', ');
  1445. AppendPasSHFragment(CodeEl, CurVariant.Values[j], 0);
  1446. end;
  1447. AppendSym(CodeEl, ': (');
  1448. AppendType(CodeEl, TableEl, CurVariant.Members, True, NestingLevel + 3);
  1449. CodeEl := CreateCode(CreatePara(CreateTD_vtop(CreateTR(TableEl))));
  1450. AppendNbSp(CodeEl, NestingLevel * 2 + 6);
  1451. AppendSym(CodeEl, ');');
  1452. end;
  1453. end;
  1454. if not (Element.Parent is TPasVariant) then
  1455. begin
  1456. CodeEl := CreateCode(CreatePara(CreateTD(CreateTR(TableEl))));
  1457. AppendText(CodeEl, ' '); // !!!: Dirty trick, necessary for current XML writer
  1458. AppendNbSp(CodeEl, NestingLevel * 2);
  1459. AppendKw(CodeEl, 'end');
  1460. end;
  1461. Result := CodeEl;
  1462. end;
  1463. procedure THTMLWriter.AppendTitle(const AText: DOMString);
  1464. begin
  1465. AppendText(TitleElement, AText);
  1466. AppendText(CreateH1(BodyElement), AText);
  1467. end;
  1468. procedure THTMLWriter.AppendTopicMenuBar(Topic : TTopicElement);
  1469. var
  1470. TableEl, TREl, ParaEl, TitleEl: TDOMElement;
  1471. procedure AddLink(El : TPasElement; const AName: String);
  1472. begin
  1473. AppendText(ParaEl, '[');
  1474. AppendText(CreateLink(ParaEl, ResolveLinkWithinPackage(El,0)),AName);
  1475. AppendText(ParaEl, ']');
  1476. end;
  1477. begin
  1478. TableEl := CreateEl(BodyElement, 'table');
  1479. TableEl['cellpadding'] := '4';
  1480. TableEl['cellspacing'] := '0';
  1481. TableEl['border'] := '0';
  1482. TableEl['width'] := '100%';
  1483. TableEl['class'] := 'bar';
  1484. TREl := CreateTR(TableEl);
  1485. ParaEl := CreateEl(CreateTD(TREl), 'b');
  1486. If Assigned(Topic.Previous) then
  1487. AddLink(Topic.Previous,SDocPrevious);
  1488. If Assigned(Topic.Parent) then
  1489. AddLink(Topic.Parent,SDocUp);
  1490. if Assigned(Topic.Next) then
  1491. AddLink(Topic.Next,SDocNext);
  1492. if Length(SearchPage) > 0 then
  1493. begin
  1494. AppendText(ParaEl, '[');
  1495. AppendText(CreateLink(ParaEl, SearchPage), SDocSearch);
  1496. AppendText(ParaEl, ']');
  1497. end;
  1498. ParaEl := CreateTD(TREl);
  1499. ParaEl['align'] := 'right';
  1500. TitleEl := CreateEl(ParaEl, 'span');
  1501. TitleEl['class'] := 'bartitle';
  1502. if Assigned(Module) then
  1503. AppendText(TitleEl, Format(SDocUnitTitle, [Module.Name]));
  1504. if Assigned(Package) then
  1505. begin
  1506. AppendText(TitleEl, ' (');
  1507. AppendHyperlink(TitleEl, Package);
  1508. AppendText(TitleEl, ')');
  1509. end;
  1510. end;
  1511. procedure THTMLWriter.AppendMenuBar(ASubpageIndex: Integer);
  1512. var
  1513. TableEl, TREl, ParaEl, TitleEl: TDOMElement;
  1514. procedure AddLink(ALinkSubpageIndex: Integer; const AName: String);
  1515. begin
  1516. AppendText(ParaEl, '[');
  1517. if ALinkSubpageIndex = ASubpageIndex then
  1518. AppendText(ParaEl, AName)
  1519. else
  1520. AppendText(
  1521. CreateLink(ParaEl, ResolveLinkWithinPackage(Module, ALinkSubpageIndex)),
  1522. AName);
  1523. AppendText(ParaEl, ']');
  1524. end;
  1525. begin
  1526. TableEl := CreateEl(BodyElement, 'table');
  1527. TableEl['cellpadding'] := '4';
  1528. TableEl['cellspacing'] := '0';
  1529. TableEl['border'] := '0';
  1530. TableEl['width'] := '100%';
  1531. TableEl['class'] := 'bar';
  1532. TREl := CreateTR(TableEl);
  1533. ParaEl := CreateEl(CreateTD(TREl), 'b');
  1534. if Assigned(Module) then
  1535. begin
  1536. AddLink(0, SDocOverview);
  1537. if Module.InterfaceSection.ResStrings.Count > 0 then
  1538. AddLink(ResstrSubindex, SDocResStrings);
  1539. if Module.InterfaceSection.Consts.Count > 0 then
  1540. AddLink(ConstsSubindex, SDocConstants);
  1541. if Module.InterfaceSection.Types.Count > 0 then
  1542. AddLink(TypesSubindex, SDocTypes);
  1543. if Module.InterfaceSection.Classes.Count > 0 then
  1544. AddLink(ClassesSubindex, SDocClasses);
  1545. if Module.InterfaceSection.Functions.Count > 0 then
  1546. AddLink(ProcsSubindex, SDocProceduresAndFunctions);
  1547. if Module.InterfaceSection.Variables.Count > 0 then
  1548. AddLink(VarsSubindex, SDocVariables);
  1549. end;
  1550. if Length(SearchPage) > 0 then
  1551. begin
  1552. AppendText(ParaEl, '[');
  1553. AppendText(CreateLink(ParaEl, SearchPage), SDocSearch);
  1554. AppendText(ParaEl, ']');
  1555. end;
  1556. ParaEl := CreateTD(TREl);
  1557. ParaEl['align'] := 'right';
  1558. TitleEl := CreateEl(ParaEl, 'span');
  1559. TitleEl['class'] := 'bartitle';
  1560. if Assigned(Module) then
  1561. AppendText(TitleEl, Format(SDocUnitTitle, [Module.Name]));
  1562. if Assigned(Package) then
  1563. begin
  1564. AppendText(TitleEl, ' (');
  1565. AppendHyperlink(TitleEl, Package);
  1566. AppendText(TitleEl, ')');
  1567. end;
  1568. end;
  1569. procedure THTMLWriter.AppendSourceRef(AElement: TPasElement);
  1570. begin
  1571. AppendText(CreatePara(BodyElement), Format(SDocSourcePosition,
  1572. [ExtractFileName(AElement.SourceFilename), AElement.SourceLinenumber]));
  1573. end;
  1574. Procedure THTMLWriter.AppendSeeAlsoSection(AElement : TPasElement;DocNode : TDocNode);
  1575. var
  1576. Node: TDOMNode;
  1577. TableEl, El, TREl, TDEl, ParaEl, NewEl, DescrEl: TDOMElement;
  1578. l,s: String;
  1579. f: Text;
  1580. IsFirstSeeAlso : Boolean;
  1581. begin
  1582. if Not (Assigned(DocNode) and Assigned(DocNode.SeeAlso)) then
  1583. Exit;
  1584. IsFirstSeeAlso := True;
  1585. Node:=DocNode.SeeAlso.FirstChild;
  1586. While Assigned(Node) do
  1587. begin
  1588. if (Node.NodeType=ELEMENT_NODE) and (Node.NodeName='link') then
  1589. begin
  1590. if IsFirstSeeAlso then
  1591. begin
  1592. IsFirstSeeAlso := False;
  1593. AppendText(CreateH2(BodyElement), SDocSeeAlso);
  1594. TableEl := CreateTable(BodyElement);
  1595. end;
  1596. El:=TDOMElement(Node);
  1597. TREl:=CreateTR(TableEl);
  1598. ParaEl:=CreatePara(CreateTD_vtop(TREl));
  1599. l:=El['id'];
  1600. s:= ResolveLinkID(l);
  1601. if Length(s)=0 then
  1602. begin
  1603. WriteLn(Format(SErrUnknownLinkID, [l]));
  1604. NewEl := CreateEl(ParaEl,'b')
  1605. end
  1606. else
  1607. NewEl := CreateLink(ParaEl,s);
  1608. AppendText(NewEl,El['id']);
  1609. l:=El['id'];
  1610. DescrEl := Engine.FindShortDescr(AElement.GetModule,L);
  1611. if Assigned(DescrEl) then
  1612. begin
  1613. AppendNbSp(CreatePara(CreateTD(TREl)), 2);
  1614. ParaEl := CreatePara(CreateTD(TREl));
  1615. ParaEl['class'] := 'cmt';
  1616. PushOutputNode(ParaEl);
  1617. try
  1618. ConvertShort(AElement, DescrEl);
  1619. finally
  1620. PopOutputNode;
  1621. end;
  1622. end;
  1623. end; // Link node
  1624. Node := Node.NextSibling;
  1625. end; // While
  1626. end;
  1627. Procedure THTMLWriter.AppendExampleSection(AElement : TPasElement;DocNode : TDocNode);
  1628. var
  1629. Node: TDOMNode;
  1630. // TableEl, El, TREl, TDEl, ParaEl, NewEl, DescrEl: TDOMElement;
  1631. s: String;
  1632. f: Text;
  1633. begin
  1634. if not (Assigned(DocNode) and Assigned(DocNode.FirstExample)) then
  1635. Exit;
  1636. Node := DocNode.FirstExample;
  1637. while Assigned(Node) do
  1638. begin
  1639. if (Node.NodeType = ELEMENT_NODE) and (Node.NodeName = 'example') then
  1640. begin
  1641. AppendText(CreateH2(BodyElement), SDocExample);
  1642. try
  1643. Assign(f, Engine.GetExampleFilename(TDOMElement(Node)));
  1644. Reset(f);
  1645. try
  1646. PushOutputNode(BodyElement);
  1647. DescrBeginCode(False, TDOMElement(Node)['highlighter']);
  1648. while not EOF(f) do
  1649. begin
  1650. ReadLn(f, s);
  1651. DescrWriteCodeLine(s);
  1652. end;
  1653. DescrEndCode;
  1654. PopOutputNode;
  1655. finally
  1656. Close(f);
  1657. end;
  1658. except
  1659. on e: Exception do
  1660. begin
  1661. e.Message := '[example] ' + e.Message;
  1662. raise;
  1663. end;
  1664. end;
  1665. end;
  1666. Node := Node.NextSibling;
  1667. end;
  1668. end;
  1669. procedure THTMLWriter.AppendFooter;
  1670. begin
  1671. if FooterFile<>'' then
  1672. ReadXMLFragment(BodyElement, FooterFile);
  1673. end;
  1674. procedure THTMLWriter.FinishElementPage(AElement: TPasElement);
  1675. var
  1676. DocNode: TDocNode;
  1677. begin
  1678. DocNode := Engine.FindDocNode(AElement);
  1679. If Assigned(DocNode) then
  1680. begin
  1681. // Description
  1682. if Assigned(DocNode.Descr) then
  1683. AppendDescrSection(AElement, BodyElement, DocNode.Descr, SDocDescription);
  1684. // Append "Errors" section
  1685. if Assigned(DocNode.ErrorsDoc) then
  1686. AppendDescrSection(AElement, BodyElement, DocNode.ErrorsDoc, SDocErrors);
  1687. // Append "See also" section
  1688. AppendSeeAlsoSection(AElement,DocNode);
  1689. // Append examples, if present
  1690. AppendExampleSection(AElement,DocNode);
  1691. end;
  1692. end;
  1693. Procedure THTMLWriter.CreateTopicPageBody(AElement : TTopicElement);
  1694. var
  1695. DocNode: TDocNode;
  1696. TableEl, TREl: TDOMElement;
  1697. I : Integer;
  1698. S : String;
  1699. begin
  1700. AppendTopicMenuBar(AElement);
  1701. DocNode:=AElement.TopicNode;
  1702. if Assigned(DocNode) then // should always be true, but we're being careful.
  1703. begin
  1704. AppendShortDescr(AElement,TitleElement, DocNode);
  1705. AppendShortDescr(AElement,CreateH2(BodyElement), DocNode);
  1706. if Assigned(DocNode.Descr) then
  1707. AppendDescrSection(AElement, BodyElement, DocNode.Descr, '');
  1708. AppendSeeAlsoSection(AElement,DocNode);
  1709. CreateTopicLinks(DocNode,AElement);
  1710. AppendExampleSection(AElement,DocNode);
  1711. end;
  1712. end;
  1713. procedure THTMLWriter.CreatePageBody(AElement: TPasElement;
  1714. ASubpageIndex: Integer);
  1715. var
  1716. i: Integer;
  1717. Element: TPasElement;
  1718. begin
  1719. CurDirectory := Allocator.GetFilename(AElement, ASubpageIndex);
  1720. i := Length(CurDirectory);
  1721. while (i > 0) and not (CurDirectory[i] in DirSeparators) do
  1722. Dec(i);
  1723. CurDirectory := Copy(CurDirectory, 1, i);
  1724. BaseDirectory := Allocator.GetRelativePathToTop(AElement);
  1725. if AElement.ClassType = TPasPackage then
  1726. CreatePackagePageBody
  1727. else
  1728. begin
  1729. Element := AElement;
  1730. while (Element<>Nil) and (Element.ClassType<>TPasModule) do
  1731. Element := Element.Parent;
  1732. Module := TPasModule(Element);
  1733. if AElement.ClassType = TPasModule then
  1734. CreateModulePageBody(TPasModule(AElement), ASubpageIndex)
  1735. else if AElement.Parent.InheritsFrom(TPasClassType) then
  1736. CreateClassMemberPageBody(AElement)
  1737. else if AElement.ClassType = TPasConst then
  1738. CreateConstPageBody(TPasConst(AElement))
  1739. else if AElement.InheritsFrom(TPasClassType) then
  1740. CreateClassPageBody(TPasClassType(AElement), ASubpageIndex)
  1741. else if AElement.InheritsFrom(TPasType) then
  1742. CreateTypePageBody(TPasType(AElement))
  1743. else if AElement.ClassType = TPasVariable then
  1744. CreateVarPageBody(TPasVariable(AElement))
  1745. else if AElement.InheritsFrom(TPasProcedureBase) then
  1746. CreateProcPageBody(TPasProcedure(AElement))
  1747. else if AElement.ClassType = TTopicELement then
  1748. CreateTopicPageBody(TTopicElement(AElement))
  1749. end;
  1750. end;
  1751. procedure THTMLWriter.CreatePackagePageBody;
  1752. var
  1753. DocNode: TDocNode;
  1754. TableEl, TREl: TDOMElement;
  1755. i: Integer;
  1756. ThisModule: TPasModule;
  1757. L : TStringList;
  1758. begin
  1759. AppendMenuBar(0);
  1760. AppendTitle(Format(SDocPackageTitle, [Copy(Package.Name, 2, 256)]));
  1761. AppendShortDescr(CreatePara(BodyElement), Package);
  1762. AppendText(CreateH2(BodyElement), SDocUnits);
  1763. TableEl := CreateTable(BodyElement);
  1764. L:=TStringList.Create;
  1765. Try
  1766. L.Sorted:=True;
  1767. // Sort modules.
  1768. For I:=0 to Package.Modules.Count-1 do
  1769. L.AddObject(TPasModule(Package.Modules[i]).Name,TPasModule(Package.Modules[i]));
  1770. // Now create table.
  1771. for i:=0 to L.Count - 1 do
  1772. begin
  1773. ThisModule := TPasModule(L.Objects[i]);
  1774. TREl := CreateTR(TableEl);
  1775. AppendHyperlink(CreateCode(CreatePara(CreateTD_vtop(TREl))), ThisModule);
  1776. AppendShortDescrCell(TREl, ThisModule);
  1777. end;
  1778. Finally
  1779. L.Free;
  1780. end;
  1781. DocNode := Engine.FindDocNode(Package);
  1782. if Assigned(DocNode) then
  1783. begin
  1784. if Assigned(DocNode.Descr) then
  1785. AppendDescrSection(nil, BodyElement, DocNode.Descr, SDocDescription);
  1786. CreateTopicLinks(DocNode,Package);
  1787. end;
  1788. end;
  1789. Procedure THTMLWriter.CreateTopicLinks(Node : TDocNode; PasElement : TPasElement);
  1790. var
  1791. DocNode: TDocNode;
  1792. TableEl, TREl: TDOMElement;
  1793. First : Boolean;
  1794. ThisTopic: TPasElement;
  1795. begin
  1796. DocNode:=Node.FirstChild;
  1797. First:=True;
  1798. While Assigned(DocNode) do
  1799. begin
  1800. If DocNode.TopicNode then
  1801. begin
  1802. if first then
  1803. begin
  1804. First:=False;
  1805. AppendText(CreateH2(BodyElement), SDocRelatedTopics);
  1806. TableEl := CreateTable(BodyElement);
  1807. end;
  1808. TREl := CreateTR(TableEl);
  1809. ThisTopic:=FindTopicElement(DocNode);
  1810. if Assigned(ThisTopic) then
  1811. AppendHyperlink(CreateCode(CreatePara(CreateTD_vtop(TREl))), ThisTopic);
  1812. AppendShortDescrCell(TREl, ThisTopic);
  1813. end;
  1814. DocNode:=DocNode.NextSibling;
  1815. end;
  1816. end;
  1817. procedure THTMLWriter.CreateModulePageBody(AModule: TPasModule;
  1818. ASubpageIndex: Integer);
  1819. procedure CreateMainPage;
  1820. var
  1821. TableEl, TREl, TDEl, CodeEl: TDOMElement;
  1822. i: Integer;
  1823. UnitRef: TPasType;
  1824. DocNode: TDocNode;
  1825. begin
  1826. AppendMenuBar(0);
  1827. AppendTitle(Format(SDocUnitTitle, [AModule.Name]));
  1828. AppendShortDescr(CreatePara(BodyElement), AModule);
  1829. if AModule.InterfaceSection.UsesList.Count > 0 then
  1830. begin
  1831. TableEl := CreateTable(BodyElement);
  1832. AppendKw(CreateCode(CreatePara(CreateTD(CreateTR(TableEl)))), 'uses');
  1833. for i := 0 to AModule.InterfaceSection.UsesList.Count - 1 do
  1834. begin
  1835. UnitRef := TPasType(AModule.InterfaceSection.UsesList[i]);
  1836. DocNode := Engine.FindDocNode(UnitRef);
  1837. if Assigned(DocNode) and DocNode.IsSkipped then
  1838. continue;
  1839. TREl := CreateTR(TableEl);
  1840. TDEl := CreateTD_vtop(TREl);
  1841. CodeEl := CreateCode(CreatePara(TDEl));
  1842. AppendNbSp(CodeEl, 2);
  1843. AppendHyperlink(CodeEl, UnitRef);
  1844. if i < AModule.InterfaceSection.UsesList.Count - 1 then
  1845. AppendSym(CodeEl, ',')
  1846. else
  1847. AppendSym(CodeEl, ';');
  1848. AppendText(CodeEl, ' '); // Space for descriptions
  1849. AppendShortDescrCell(TREl, UnitRef);
  1850. end;
  1851. end;
  1852. DocNode := Engine.FindDocNode(AModule);
  1853. if Assigned(DocNode) then
  1854. begin
  1855. if Assigned(DocNode.Descr) then
  1856. AppendDescrSection(AModule, BodyElement, DocNode.Descr, SDocOverview);
  1857. CreateTopicLinks(DocNode,AModule);
  1858. end;
  1859. end;
  1860. procedure CreateSimpleSubpage(const ATitle: DOMString; AList: TList);
  1861. var
  1862. TableEl, TREl, TDEl, CodeEl: TDOMElement;
  1863. i, j: Integer;
  1864. Decl: TPasElement;
  1865. SortedList: TList;
  1866. DocNode: TDocNode;
  1867. S : String;
  1868. begin
  1869. AppendMenuBar(ASubpageIndex);
  1870. S:=ATitle;
  1871. AppendTitle(Format(SDocUnitTitle + ': %s', [AModule.Name, S]));
  1872. SortedList := TList.Create;
  1873. try
  1874. for i := 0 to AList.Count - 1 do
  1875. begin
  1876. Decl := TPasElement(AList[i]);
  1877. DocNode := Engine.FindDocNode(Decl);
  1878. if (not Assigned(DocNode)) or (not DocNode.IsSkipped) then
  1879. begin
  1880. j := 0;
  1881. while (j < SortedList.Count) and (CompareText(
  1882. TPasElement(SortedList[j]).PathName, Decl.PathName) < 0) do
  1883. Inc(j);
  1884. SortedList.Insert(j, Decl);
  1885. end;
  1886. end;
  1887. TableEl := CreateTable(BodyElement);
  1888. for i := 0 to SortedList.Count - 1 do
  1889. begin
  1890. Decl := TPasElement(SortedList[i]);
  1891. TREl := CreateTR(TableEl);
  1892. CodeEl := CreateCode(CreatePara(CreateTD_vtop(TREl)));
  1893. AppendHyperlink(CodeEl, Decl);
  1894. AppendShortDescrCell(TREl, Decl);
  1895. end;
  1896. finally
  1897. SortedList.Free;
  1898. end;
  1899. end;
  1900. procedure CreateResStringsPage;
  1901. var
  1902. ParaEl: TDOMElement;
  1903. i, j: Integer;
  1904. Decl: TPasResString;
  1905. DocNode: TDocNode;
  1906. begin
  1907. AppendMenuBar(ResstrSubindex);
  1908. AppendTitle(Format(SDocUnitTitle + ': %s', [AModule.Name, SDocResStrings]));
  1909. for i := 0 to AModule.InterfaceSection.ResStrings.Count - 1 do
  1910. begin
  1911. Decl := TPasResString(AModule.InterfaceSection.ResStrings[i]);
  1912. CreateEl(BodyElement, 'a')['name'] := LowerCase(Decl.Name);
  1913. ParaEl := CreatePara(BodyElement);
  1914. AppendText(CreateCode(ParaEl), Decl.Name);
  1915. CreateEl(ParaEl, 'br');
  1916. AppendText(ParaEl, Decl.Value);
  1917. end;
  1918. end;
  1919. begin
  1920. case ASubpageIndex of
  1921. 0:
  1922. CreateMainPage;
  1923. ResstrSubindex:
  1924. CreateResStringsPage;
  1925. ConstsSubindex:
  1926. CreateSimpleSubpage(SDocConstants, AModule.InterfaceSection.Consts);
  1927. TypesSubindex:
  1928. CreateSimpleSubpage(SDocTypes, AModule.InterfaceSection.Types);
  1929. ClassesSubindex:
  1930. CreateSimpleSubpage(SDocClasses, AModule.InterfaceSection.Classes);
  1931. ProcsSubindex:
  1932. CreateSimpleSubpage(SDocProceduresAndFunctions, AModule.InterfaceSection.Functions);
  1933. VarsSubindex:
  1934. CreateSimpleSubpage(SDocVariables, AModule.InterfaceSection.Variables);
  1935. end;
  1936. end;
  1937. procedure THTMLWriter.CreateConstPageBody(AConst: TPasConst);
  1938. var
  1939. TableEl, CodeEl: TDOMElement;
  1940. begin
  1941. AppendMenuBar(-1);
  1942. AppendTitle(AConst.Name);
  1943. AppendShortDescr(CreatePara(BodyElement), AConst);
  1944. AppendText(CreateH2(BodyElement), SDocDeclaration);
  1945. AppendSourceRef(AConst);
  1946. TableEl := CreateTable(BodyElement);
  1947. CodeEl := CreateCode(CreatePara(CreateTD(CreateTR(TableEl))));
  1948. AppendKw(CodeEl, 'const');
  1949. AppendText(CodeEl, ' ' + AConst.Name);
  1950. if Assigned(AConst.VarType) then
  1951. begin
  1952. AppendSym(CodeEl, ': ');
  1953. AppendType(CodeEl, TableEl, AConst.VarType, False);
  1954. end;
  1955. AppendPasSHFragment(CodeEl, ' = ' + AConst.Value + ';', 0);
  1956. FinishElementPage(AConst);
  1957. end;
  1958. procedure THTMLWriter.CreateTypePageBody(AType: TPasType);
  1959. var
  1960. TableEl, TREl, TDEl, CodeEl: TDOMElement;
  1961. DocNode: TDocNode;
  1962. i: Integer;
  1963. s: String;
  1964. EnumType: TPasEnumType;
  1965. EnumValue: TPasEnumValue;
  1966. Variable: TPasVariable;
  1967. begin
  1968. AppendMenuBar(-1);
  1969. AppendTitle(AType.Name);
  1970. AppendShortDescr(CreatePara(BodyElement), AType);
  1971. AppendText(CreateH2(BodyElement), SDocDeclaration);
  1972. AppendSourceRef(AType);
  1973. TableEl := CreateTable(BodyElement);
  1974. TREl := CreateTR(TableEl);
  1975. TDEl := CreateTD(TREl);
  1976. CodeEl := CreateCode(CreatePara(TDEl));
  1977. DocNode := Engine.FindDocNode(AType);
  1978. AppendKw(CodeEl, 'type ');
  1979. AppendText(CodeEl, AType.Name);
  1980. AppendSym(CodeEl, ' = ');
  1981. If Assigned(DocNode) and
  1982. Assigned(DocNode.Node) and
  1983. (Docnode.Node['opaque']='1') then
  1984. AppendText(CodeEl,SDocOpaque)
  1985. else
  1986. begin
  1987. // Alias
  1988. if AType.ClassType = TPasAliasType then
  1989. begin
  1990. if Assigned(TPasAliasType(AType).DestType) then
  1991. AppendHyperlink(CodeEl, TPasAliasType(AType).DestType)
  1992. else
  1993. AppendText(CreateWarning(CodeEl), '<Destination type is NIL>');
  1994. AppendSym(CodeEl, ';');
  1995. end else
  1996. // Class of
  1997. if AType.ClassType = TPasClassOfType then
  1998. begin
  1999. AppendKw(CodeEl, 'class of ');
  2000. AppendHyperlink(CodeEl, TPasClassOfType(AType).DestType);
  2001. AppendSym(CodeEl, ';');
  2002. end else
  2003. // Enumeration
  2004. if AType.ClassType = TPasEnumType then
  2005. begin
  2006. AppendSym(CodeEl, '(');
  2007. for i := 0 to TPasEnumType(AType).Values.Count - 1 do
  2008. begin
  2009. EnumValue := TPasEnumValue(TPasEnumType(AType).Values[i]);
  2010. TREl := CreateTR(TableEl);
  2011. CodeEl := CreateCode(CreatePara(CreateTD_vtop(TREl)));
  2012. AppendShortDescrCell(TREl, EnumValue);
  2013. AppendNbSp(CodeEl, 2);
  2014. s := EnumValue.Name;
  2015. if EnumValue.IsValueUsed then
  2016. s := s + ' = ' + IntToStr(EnumValue.Value);
  2017. if i < TPasEnumType(AType).Values.Count - 1 then
  2018. s := s + ',';
  2019. AppendPasSHFragment(CodeEl, s, 0);
  2020. end;
  2021. AppendSym(CreateCode(CreatePara(CreateTD(CreateTR(TableEl)))), ');');
  2022. end else
  2023. // Pointer type
  2024. if AType.ClassType = TPasPointerType then
  2025. begin
  2026. AppendSym(CodeEl, '^');
  2027. if Assigned(TPasPointerType(AType).DestType) then
  2028. AppendHyperlink(CodeEl, TPasPointerType(AType).DestType)
  2029. else
  2030. AppendText(CreateWarning(CodeEl), '<Destination type is NIL>');
  2031. AppendSym(CodeEl, ';');
  2032. end else
  2033. if AType.InheritsFrom(TPasProcedureType) then
  2034. begin
  2035. AppendSym(AppendType(CodeEl, TableEl, TPasType(AType), True), ';');
  2036. AppendProcArgsSection(BodyElement, TPasProcedureType(AType));
  2037. end else
  2038. // Record
  2039. if AType.ClassType = TPasRecordType then
  2040. begin
  2041. CodeEl := AppendRecordType(CodeEl, TableEl, TPasRecordType(AType), 0);
  2042. AppendSym(CodeEl, ';');
  2043. end else
  2044. // Set
  2045. if AType.ClassType = TPasSetType then
  2046. begin
  2047. AppendKw(CodeEl, 'set of ');
  2048. if TPasSetType(AType).EnumType.ClassType = TPasEnumType then
  2049. begin
  2050. AppendSym(CodeEl, '(');
  2051. EnumType := TPasEnumType(TPasSetType(AType).EnumType);
  2052. for i := 0 to EnumType.Values.Count - 1 do
  2053. begin
  2054. EnumValue := TPasEnumValue(EnumType.Values[i]);
  2055. TREl := CreateTR(TableEl);
  2056. CodeEl := CreateCode(CreatePara(CreateTD_vtop(TREl)));
  2057. AppendShortDescrCell(TREl, EnumValue);
  2058. AppendNbSp(CodeEl, 2);
  2059. s := EnumValue.Name;
  2060. if EnumValue.IsValueUsed then
  2061. s := s + ' = ' + IntToStr(EnumValue.Value);
  2062. if i < EnumType.Values.Count - 1 then
  2063. s := s + ',';
  2064. AppendPasSHFragment(CodeEl, s, 0);
  2065. end;
  2066. AppendSym(CreateCode(CreatePara(CreateTD(CreateTR(TableEl)))), ');');
  2067. end else
  2068. begin
  2069. AppendHyperlink(CodeEl, TPasSetType(AType).EnumType);
  2070. AppendSym(CodeEl, ';');
  2071. end;
  2072. end else
  2073. // Type alias
  2074. if AType.ClassType = TPasTypeAliasType then
  2075. begin
  2076. AppendKw(CodeEl, 'type ');
  2077. AppendHyperlink(CodeEl, TPasTypeAliasType(AType).DestType);
  2078. AppendSym(CodeEl, ';');
  2079. end else
  2080. // Probably one of the simple types, which allowed in other places as wel...
  2081. AppendSym(AppendType(CodeEl, TableEl, TPasType(AType), True), ';');
  2082. end;
  2083. FinishElementPage(AType);
  2084. end;
  2085. function PropertyFilter(AMember: TPasElement): Boolean;
  2086. begin
  2087. Result := (AMember.ClassType = TPasProperty) and
  2088. (Copy(AMember.Name, 1, 2) <> 'On');
  2089. end;
  2090. function MethodFilter(AMember: TPasElement): Boolean;
  2091. begin
  2092. Result := AMember.InheritsFrom(TPasProcedureBase);
  2093. end;
  2094. function EventFilter(AMember: TPasElement): Boolean;
  2095. begin
  2096. Result := (AMember.ClassType = TPasProperty) and
  2097. (Copy(AMember.Name, 1, 2) = 'On');
  2098. end;
  2099. procedure THTMLWriter.CreateClassPageBody(AClass: TPasClassType;
  2100. ASubpageIndex: Integer);
  2101. type
  2102. TMemberFilter = function(AMember: TPasElement): Boolean;
  2103. var
  2104. ParaEl: TDOMElement;
  2105. procedure AppendMemberListLink(AListSubpageIndex: Integer;
  2106. const AText: DOMString);
  2107. var
  2108. LinkEl: TDOMElement;
  2109. begin
  2110. AppendText(ParaEl, '[');
  2111. LinkEl := CreateEl(ParaEl, 'a');
  2112. LinkEl['href'] :=
  2113. FixHtmlPath(ResolveLinkWithinPackage(AClass, AListSubpageIndex));
  2114. LinkEl['onClick'] := 'window.open(''' + LinkEl['href'] + ''', ''list'', ' +
  2115. '''dependent=yes,resizable=yes,scrollbars=yes,height=400,width=300''); return false;';
  2116. AppendText(LinkEl, AText);
  2117. AppendText(ParaEl, ' (');
  2118. LinkEl := CreateEl(ParaEl, 'a');
  2119. LinkEl['href'] :=
  2120. FixHtmlPath(ResolveLinkWithinPackage(AClass, AListSubpageIndex + 1));
  2121. LinkEl['onClick'] := 'window.open(''' + LinkEl['href'] + ''', ''list'', ' +
  2122. '''dependent=yes,resizable=yes,scrollbars=yes,height=400,width=300''); return false;';
  2123. AppendText(LinkEl, SDocByName);
  2124. AppendText(ParaEl, ')');
  2125. AppendText(ParaEl, '] ');
  2126. end;
  2127. procedure CreateMainPage;
  2128. var
  2129. TableEl, TREl, TDEl, CodeEl: TDOMElement;
  2130. DocNode: TDocNode;
  2131. Member: TPasElement;
  2132. CurVisibility: TPasMemberVisibility;
  2133. i: Integer;
  2134. s: String;
  2135. ThisClass: TPasClassType;
  2136. HaveSeenTObject: Boolean;
  2137. begin
  2138. AppendMenuBar(-1);
  2139. AppendTitle(AClass.Name);
  2140. ParaEl := CreatePara(BodyElement);
  2141. AppendMemberListLink(PropertiesByInheritanceSubindex, SDocProperties);
  2142. AppendMemberListLink(MethodsByInheritanceSubindex, SDocMethods);
  2143. AppendMemberListLink(EventsByInheritanceSubindex, SDocEvents);
  2144. AppendShortDescr(CreatePara(BodyElement), AClass);
  2145. AppendText(CreateH2(BodyElement), SDocDeclaration);
  2146. AppendSourceRef(AClass);
  2147. TableEl := CreateTable(BodyElement);
  2148. TREl := CreateTR(TableEl);
  2149. TDEl := CreateTD(TREl);
  2150. CodeEl := CreateCode(CreatePara(TDEl));
  2151. AppendKw(CodeEl, 'type');
  2152. AppendText(CodeEl, ' ' + AClass.Name + ' ');
  2153. AppendSym(CodeEl, '=');
  2154. AppendText(CodeEl, ' ');
  2155. AppendKw(CodeEl, ObjKindNames[AClass.ObjKind]);
  2156. if Assigned(AClass.AncestorType) then
  2157. begin
  2158. AppendSym(CodeEl, '(');
  2159. AppendHyperlink(CodeEl, AClass.AncestorType);
  2160. AppendSym(CodeEl, ')');
  2161. end;
  2162. if AClass.Members.Count > 0 then
  2163. begin
  2164. CurVisibility := visDefault;
  2165. for i := 0 to AClass.Members.Count - 1 do
  2166. begin
  2167. Member := TPasElement(AClass.Members[i]);
  2168. if CurVisibility <> Member.Visibility then
  2169. begin
  2170. CurVisibility := Member.Visibility;
  2171. if ((CurVisibility = visPrivate) and Engine.HidePrivate) or
  2172. ((CurVisibility = visProtected) and Engine.HideProtected) then
  2173. continue;
  2174. case CurVisibility of
  2175. visPrivate: s := 'private';
  2176. visProtected: s := 'protected';
  2177. visPublic: s := 'public';
  2178. visPublished: s := 'published';
  2179. visAutomated: s := 'automated';
  2180. end;
  2181. AppendKw(CreateCode(CreatePara(CreateTD(CreateTR(TableEl)))), s);
  2182. end else
  2183. if ((CurVisibility = visPrivate) and Engine.HidePrivate) or
  2184. ((CurVisibility = visProtected) and Engine.HideProtected) then
  2185. continue;
  2186. TREl := CreateTR(TableEl);
  2187. CodeEl := CreateCode(CreatePara(CreateTD_vtop(TREl)));
  2188. AppendNbSp(CodeEl, 2);
  2189. AppendShortDescrCell(TREl, Member);
  2190. if Member.InheritsFrom(TPasProcedureBase) then
  2191. begin
  2192. AppendKw(CodeEl, TPasProcedureBase(Member).TypeName + ' ');
  2193. AppendHyperlink(CodeEl, Member);
  2194. if (Member.ClassType = TPasOverloadedProc) or
  2195. (TPasProcedure(Member).ProcType.Args.Count > 0) then
  2196. AppendSym(CodeEl, '();')
  2197. else
  2198. AppendSym(CodeEl, ';');
  2199. if Member.ClassType <> TPasOverloadedProc then
  2200. AppendProcExt(CodeEl, TPasProcedure(Member));
  2201. end else
  2202. if Member.ClassType = TPasVariable then
  2203. begin
  2204. AppendHyperlink(CodeEl, Member);
  2205. AppendSym(CodeEl, ': ');
  2206. AppendHyperlink(CodeEl, TPasVariable(Member).VarType);
  2207. AppendSym(CodeEl, ';');
  2208. end else
  2209. if Member.ClassType = TPasProperty then
  2210. begin
  2211. AppendKw(CodeEl, 'property ');
  2212. AppendHyperlink(CodeEl, Member);
  2213. if Assigned(TPasProperty(Member).VarType) then
  2214. begin
  2215. AppendSym(CodeEl, ': ');
  2216. AppendHyperlink(CodeEl, TPasProperty(Member).VarType);
  2217. end;
  2218. AppendSym(CodeEl, ';');
  2219. if TPasProperty(Member).IsDefault then
  2220. begin
  2221. AppendKw(CodeEl, ' default');
  2222. AppendSym(CodeEl, ';');
  2223. end;
  2224. SetLength(s, 0);
  2225. if Length(TPasProperty(Member).ReadAccessorName) > 0 then
  2226. s := s + 'r';
  2227. if Length(TPasProperty(Member).WriteAccessorName) > 0 then
  2228. s := s + 'w';
  2229. if Length(TPasProperty(Member).StoredAccessorName) > 0 then
  2230. s := s + 's';
  2231. if Length(s) > 0 then
  2232. AppendText(CodeEl, ' [' + s + ']');
  2233. end else
  2234. AppendText(CreateWarning(CodeEl), '<' + Member.ClassName + '>');
  2235. end;
  2236. CodeEl := CreateCode(CreatePara(CreateTD(CreateTR(TableEl))));
  2237. end;
  2238. AppendText(CodeEl, ' '); // !!!: Dirty trick, necessary for current XML writer
  2239. AppendKw(CodeEl, 'end');
  2240. AppendSym(CodeEl, ';');
  2241. AppendText(CreateH2(BodyElement), SDocInheritance);
  2242. TableEl := CreateTable(BodyElement);
  2243. HaveSeenTObject := AClass.ObjKind <> okClass;
  2244. ThisClass := AClass;
  2245. while True do
  2246. begin
  2247. TREl := CreateTR(TableEl);
  2248. TDEl := CreateTD_vtop(TREl);
  2249. TDEl['align'] := 'center';
  2250. CodeEl := CreateCode(CreatePara(TDEl));
  2251. AppendHyperlink(CodeEl, ThisClass);
  2252. AppendShortDescrCell(TREl, ThisClass);
  2253. if HaveSeenTObject or (CompareText(ThisClass.Name, 'TObject') = 0) then
  2254. HaveSeenTObject := True
  2255. else
  2256. begin
  2257. TDEl := CreateTD(CreateTR(TableEl));
  2258. TDEl['align'] := 'center';
  2259. AppendText(TDEl, '|');
  2260. end;
  2261. if Assigned(ThisClass.AncestorType) then
  2262. begin
  2263. if ThisClass.AncestorType.InheritsFrom(TPasClassType) then
  2264. ThisClass := TPasClassType(ThisClass.AncestorType)
  2265. else
  2266. begin
  2267. TDEl := CreateTD(CreateTR(TableEl));
  2268. TDEl['align'] := 'center';
  2269. AppendText(CreateCode(CreatePara(TDEl)), ThisClass.AncestorType.Name);
  2270. if CompareText(ThisClass.AncestorType.Name, 'TObject') = 0 then
  2271. HaveSeenTObject := True
  2272. else
  2273. begin
  2274. TDEl := CreateTD(CreateTR(TableEl));
  2275. TDEl['align'] := 'center';
  2276. AppendText(TDEl, '?');
  2277. end;
  2278. break;
  2279. end
  2280. end else
  2281. break;
  2282. end;
  2283. if not HaveSeenTObject then
  2284. begin
  2285. TDEl := CreateTD(CreateTR(TableEl));
  2286. TDEl['align'] := 'center';
  2287. AppendText(CreateCode(CreatePara(TDEl)), 'TObject');
  2288. end;
  2289. FinishElementPage(AClass);
  2290. end;
  2291. procedure CreateInheritanceSubpage(AFilter: TMemberFilter);
  2292. var
  2293. ThisClass: TPasClassType;
  2294. i: Integer;
  2295. Member: TPasElement;
  2296. TableEl, TREl, TDEl, ParaEl, LinkEl: TDOMElement;
  2297. begin
  2298. TableEl := CreateTable(BodyElement);
  2299. ThisClass := AClass;
  2300. while True do
  2301. begin
  2302. TREl := CreateTR(TableEl);
  2303. TDEl := CreateTD(TREl);
  2304. TDEl['colspan'] := '3';
  2305. CreateTD(TREl);
  2306. LinkEl := AppendHyperlink(CreateEl(CreateCode(CreatePara(TDEl)), 'b'), ThisClass);
  2307. if Assigned(LinkEl) then
  2308. LinkEl['onClick'] := 'opener.location.href = ''' + LinkEl['href'] +
  2309. '''; return false;';
  2310. for i := 0 to ThisClass.Members.Count - 1 do
  2311. begin
  2312. Member := TPasElement(ThisClass.Members[i]);
  2313. if ((Member.Visibility = visPrivate) and Engine.HidePrivate) or
  2314. ((Member.Visibility = visProtected) and Engine.HideProtected) or
  2315. not AFilter(Member) then
  2316. continue;
  2317. TREl := CreateTR(TableEl);
  2318. ParaEl := CreatePara(CreateTD(TREl));
  2319. case Member.Visibility of
  2320. visPrivate:
  2321. AppendText(ParaEl, 'pv');
  2322. visProtected:
  2323. AppendText(ParaEl, 'pt');
  2324. visPublished:
  2325. AppendText(ParaEl, 'pl');
  2326. end;
  2327. AppendNbSp(ParaEl, 1);
  2328. ParaEl := CreateTD(TREl);
  2329. if (Member.ClassType = TPasProperty) and
  2330. (Length(TPasProperty(Member).WriteAccessorName) = 0) then
  2331. begin
  2332. AppendText(ParaEl, 'ro');
  2333. AppendNbSp(ParaEl, 1);
  2334. end;
  2335. LinkEl := AppendHyperlink(CreatePara(CreateTD(TREl)), Member);
  2336. if Assigned(LinkEl) then
  2337. LinkEl['onClick'] := 'opener.location.href = ''' + LinkEl['href'] +
  2338. '''; return false;';
  2339. end;
  2340. if (not Assigned(ThisClass.AncestorType)) or
  2341. (not (ThisClass.AncestorType.ClassType = TPasClassType)) then
  2342. break;
  2343. ThisClass := TPasClassType(ThisClass.AncestorType);
  2344. AppendNbSp(CreatePara(CreateTD(CreateTR(TableEl))), 1);
  2345. end;
  2346. end;
  2347. procedure CreateSortedSubpage(AFilter: TMemberFilter);
  2348. var
  2349. List: TList;
  2350. ThisClass: TPasClassType;
  2351. i, j: Integer;
  2352. Member: TPasElement;
  2353. TableEl, TREl, TDEl, ParaEl, LinkEl: TDOMElement;
  2354. begin
  2355. List := TList.Create;
  2356. try
  2357. ThisClass := AClass;
  2358. while True do
  2359. begin
  2360. for i := 0 to ThisClass.Members.Count - 1 do
  2361. begin
  2362. Member := TPasElement(ThisClass.Members[i]);
  2363. if (not (((Member.Visibility = visPrivate) and Engine.HidePrivate) or
  2364. ((Member.Visibility = visProtected) and Engine.HideProtected))) and
  2365. AFilter(Member) then
  2366. begin
  2367. j := 0;
  2368. while (j < List.Count) and
  2369. (CompareText(TPasElement(List[j]).Name, Member.Name) < 0) do
  2370. Inc(j);
  2371. List.Insert(j, Member);
  2372. end;
  2373. end;
  2374. if (not Assigned(ThisClass.AncestorType)) or
  2375. (not (ThisClass.AncestorType.ClassType = TPasClassType)) then
  2376. break;
  2377. ThisClass := TPasClassType(ThisClass.AncestorType);
  2378. end;
  2379. TableEl := CreateTable(BodyElement);
  2380. for i := 0 to List.Count - 1 do
  2381. begin
  2382. Member := TPasElement(List[i]);
  2383. TREl := CreateTR(TableEl);
  2384. ParaEl := CreatePara(CreateTD(TREl));
  2385. case Member.Visibility of
  2386. visPrivate:
  2387. AppendText(ParaEl, 'pv');
  2388. visProtected:
  2389. AppendText(ParaEl, 'pt');
  2390. visPublished:
  2391. AppendText(ParaEl, 'pl');
  2392. end;
  2393. AppendNbSp(ParaEl, 1);
  2394. ParaEl := CreatePara(CreateTD(TREl));
  2395. if (Member.ClassType = TPasProperty) and
  2396. (Length(TPasProperty(Member).WriteAccessorName) = 0) then
  2397. begin
  2398. AppendText(ParaEl, 'ro');
  2399. AppendNbSp(ParaEl, 1);
  2400. end;
  2401. TDEl := CreateTD(TREl);
  2402. TDEl['nowrap'] := 'nowrap';
  2403. ParaEl := CreatePara(TDEl);
  2404. LinkEl := AppendHyperlink(ParaEl, Member);
  2405. if Assigned(LinkEl) then
  2406. LinkEl['onClick'] := 'opener.location.href = ''' + LinkEl['href'] +
  2407. '''; return false;';
  2408. AppendText(ParaEl, ' (');
  2409. LinkEl := AppendHyperlink(ParaEl, Member.Parent);
  2410. if Assigned(LinkEl) then
  2411. LinkEl['onClick'] := 'opener.location.href = ''' + LinkEl['href'] +
  2412. '''; return false;';
  2413. AppendText(ParaEl, ')');
  2414. end;
  2415. finally
  2416. List.Free;
  2417. end;
  2418. end;
  2419. begin
  2420. case ASubpageIndex of
  2421. 0:
  2422. CreateMainPage;
  2423. PropertiesByInheritanceSubindex:
  2424. CreateInheritanceSubpage(@PropertyFilter);
  2425. PropertiesByNameSubindex:
  2426. CreateSortedSubpage(@PropertyFilter);
  2427. MethodsByInheritanceSubindex:
  2428. CreateInheritanceSubpage(@MethodFilter);
  2429. MethodsByNameSubindex:
  2430. CreateSortedSubpage(@MethodFilter);
  2431. EventsByInheritanceSubindex:
  2432. CreateInheritanceSubpage(@EventFilter);
  2433. EventsByNameSubindex:
  2434. CreateSortedSubpage(@EventFilter);
  2435. end;
  2436. end;
  2437. procedure THTMLWriter.CreateClassMemberPageBody(AElement: TPasElement);
  2438. var
  2439. TableEl, TREl, CodeEl: TDOMElement;
  2440. procedure CreateVarPage(Element: TPasVariable);
  2441. begin
  2442. AppendHyperlink(CodeEl, Element.Parent);
  2443. AppendSym(CodeEl, '.');
  2444. AppendText(CodeEl, Element.Name);
  2445. if Assigned(Element.VarType) then
  2446. begin
  2447. AppendSym(CodeEl, ': ');
  2448. AppendSym(AppendType(CodeEl, TableEl, Element.VarType, False), ';');
  2449. end;
  2450. end;
  2451. procedure CreatePropertyPage(Element: TPasProperty);
  2452. var
  2453. NeedBreak: Boolean;
  2454. begin
  2455. AppendKw(CodeEl, 'property ');
  2456. AppendHyperlink(CodeEl, Element.Parent);
  2457. AppendSym(CodeEl, '.');
  2458. AppendText(CodeEl, Element.Name);
  2459. if Assigned(Element.VarType) then
  2460. begin
  2461. AppendSym(CodeEl, ': ');
  2462. AppendType(CodeEl, TableEl, Element.VarType, False);
  2463. end;
  2464. NeedBreak := False;
  2465. if Length(TPasProperty(Element).IndexValue) <> 0 then
  2466. begin
  2467. CreateEl(CodeEl, 'br');
  2468. AppendNbsp(CodeEl, 2);
  2469. AppendKw(CodeEl, 'index ');
  2470. AppendPasSHFragment(CodeEl, TPasProperty(Element).IndexValue, 0);
  2471. NeedBreak := True;
  2472. end;
  2473. if Length(TPasProperty(Element).ReadAccessorName) <> 0 then
  2474. begin
  2475. CreateEl(CodeEl, 'br');
  2476. AppendNbsp(CodeEl, 2);
  2477. AppendKw(CodeEl, 'read ');
  2478. AppendText(CodeEl, TPasProperty(Element).ReadAccessorName);
  2479. NeedBreak := True;
  2480. end;
  2481. if Length(TPasProperty(Element).WriteAccessorName) <> 0 then
  2482. begin
  2483. CreateEl(CodeEl, 'br');
  2484. AppendNbsp(CodeEl, 2);
  2485. AppendKw(CodeEl, 'write ');
  2486. AppendText(CodeEl, TPasProperty(Element).WriteAccessorName);
  2487. NeedBreak := True;
  2488. end;
  2489. if Length(TPasProperty(Element).StoredAccessorName) <> 0 then
  2490. begin
  2491. CreateEl(CodeEl, 'br');
  2492. AppendNbsp(CodeEl, 2);
  2493. AppendKw(CodeEl, 'stored ');
  2494. AppendText(CodeEl, TPasProperty(Element).StoredAccessorName);
  2495. NeedBreak := True;
  2496. end;
  2497. if Length(TPasProperty(Element).DefaultValue) <> 0 then
  2498. begin
  2499. CreateEl(CodeEl, 'br');
  2500. AppendNbsp(CodeEl, 2);
  2501. AppendKw(CodeEl, 'default ');
  2502. AppendPasSHFragment(CodeEl, TPasProperty(Element).DefaultValue, 0);
  2503. NeedBreak := True;
  2504. end;
  2505. AppendSym(CodeEl, ';');
  2506. if TPasProperty(Element).IsDefault or TPasProperty(Element).IsNodefault then
  2507. begin
  2508. if NeedBreak then
  2509. begin
  2510. CreateEl(CodeEl, 'br');
  2511. AppendNbsp(CodeEl, 2);
  2512. end;
  2513. if TPasProperty(Element).IsDefault then
  2514. AppendKw(CodeEl, 'default')
  2515. else
  2516. AppendKw(CodeEl, 'nodefault');
  2517. AppendSym(CodeEl, ';');
  2518. end;
  2519. end;
  2520. var
  2521. s: String;
  2522. DocNode: TDocNode;
  2523. begin
  2524. AppendMenuBar(-1);
  2525. AppendTitle(AElement.FullName);
  2526. AppendShortDescr(CreatePara(BodyElement), AElement);
  2527. AppendText(CreateH2(BodyElement), SDocDeclaration);
  2528. AppendSourceRef(AElement);
  2529. TableEl := CreateTable(BodyElement);
  2530. TREl := CreateTR(TableEl);
  2531. CodeEl := CreateCode(CreatePara(CreateTD(TREl)));
  2532. AppendText(CodeEl, ' '); // !!!: Workaround for current HTML writer
  2533. case AElement.Visibility of
  2534. visPrivate: s := 'private';
  2535. visProtected: s := 'protected';
  2536. visPublic: s := 'public';
  2537. visPublished: s := 'published';
  2538. visAutomated: s := 'automated';
  2539. else s := '';
  2540. end;
  2541. if Length(s) > 0 then
  2542. AppendKw(CodeEl, s);
  2543. AppendText(CodeEl, ' ');
  2544. if AElement.ClassType = TPasVariable then
  2545. CreateVarPage(TPasVariable(AElement))
  2546. else if AElement.InheritsFrom(TPasProcedureBase) then
  2547. AppendProcDecl(CodeEl, TableEl, TPasProcedureBase(AElement))
  2548. else if AElement.ClassType = TPasProperty then
  2549. CreatePropertyPage(TPasProperty(AElement))
  2550. else
  2551. AppendText(CreateWarning(BodyElement), '<' + AElement.ClassName + '>');
  2552. FinishElementPage(AElement);
  2553. end;
  2554. procedure THTMLWriter.CreateVarPageBody(AVar: TPasVariable);
  2555. var
  2556. TableEl, TREl, TDEl, CodeEl, El: TDOMElement;
  2557. DocNode: TDocNode;
  2558. begin
  2559. AppendMenuBar(-1);
  2560. AppendTitle(AVar.FullName);
  2561. AppendShortDescr(CreatePara(BodyElement), AVar);
  2562. AppendText(CreateH2(BodyElement), SDocDeclaration);
  2563. AppendSourceRef(AVar);
  2564. TableEl := CreateTable(BodyElement);
  2565. TREl := CreateTR(TableEl);
  2566. TDEl := CreateTD(TREl);
  2567. CodeEl := CreateCode(CreatePara(TDEl));
  2568. AppendKw(CodeEl, 'var');
  2569. AppendText(CodeEl, ' ' + AVar.Name);
  2570. if Assigned(AVar.VarType) then
  2571. begin
  2572. AppendSym(CodeEl, ': ');
  2573. El := AppendType(CodeEl, TableEl, AVar.VarType, False);
  2574. end else
  2575. El := CodeEl;
  2576. if Length(AVar.Value) > 0 then
  2577. AppendPasSHFragment(El, ' = ' + AVar.Value + ';', 0)
  2578. else
  2579. AppendSym(El, ';');
  2580. FinishElementPage(AVar);
  2581. end;
  2582. procedure THTMLWriter.CreateProcPageBody(AProc: TPasProcedureBase);
  2583. var
  2584. TableEl, TREl, TDEl, CodeEl: TDOMElement;
  2585. begin
  2586. AppendMenuBar(-1);
  2587. AppendTitle(AProc.Name);
  2588. AppendShortDescr(CreatePara(BodyElement), AProc);
  2589. AppendText(CreateH2(BodyElement), SDocDeclaration);
  2590. AppendSourceRef(AProc);
  2591. TableEl := CreateTable(BodyElement);
  2592. TREl := CreateTR(TableEl);
  2593. TDEl := CreateTD(TREl);
  2594. CodeEl := CreateCode(CreatePara(TDEl));
  2595. AppendProcDecl(CodeEl, TableEl, AProc);
  2596. FinishElementPage(AProc);
  2597. end;
  2598. Function THTMLWriter.InterPretOption(Const Cmd,Arg : String) : boolean;
  2599. begin
  2600. Result:=True;
  2601. if Cmd = '--html-search' then
  2602. SearchPage := Arg
  2603. else if Cmd = '--footer' then
  2604. FooterFile := Arg
  2605. else
  2606. Result:=False;
  2607. end;
  2608. procedure THTMLWriter.WriteDoc;
  2609. begin
  2610. WriteLn(Format(SWritingPages, [PageCount]));
  2611. WriteHTMLPages;
  2612. end;
  2613. procedure THTMLWriter.Usage(List: TStrings);
  2614. begin
  2615. List.add('--footer');
  2616. List.Add(SHTMLUsageFooter);
  2617. end;
  2618. // private methods
  2619. function THTMLWriter.GetPageCount: Integer;
  2620. begin
  2621. Result := PageInfos.Count;
  2622. end;
  2623. procedure THTMLWriter.SetOnTest(const AValue: TNotifyEvent);
  2624. begin
  2625. if FOnTest=AValue then exit;
  2626. FOnTest:=AValue;
  2627. end;
  2628. procedure THTMLWriter.CreateAllocator;
  2629. begin
  2630. FAllocator:=TLongNameFileAllocator.Create('.html');
  2631. end;
  2632. procedure THTMWriter.CreateAllocator;
  2633. begin
  2634. FAllocator:=TShortNameFileAllocator.Create('.htm');
  2635. end;
  2636. initialization
  2637. // Do not localize.
  2638. RegisterWriter(THTMLWriter,'html','HTML output using fpdoc.css stylesheet.');
  2639. RegisterWriter(THTMWriter,'htm','HTM (8.3 filenames) output using fpdoc.css stylesheet.');
  2640. finalization
  2641. UnRegisterWriter('html');
  2642. UnRegisterWriter('htm');
  2643. end.