/* * Harbour Project source code: * Document generator - HTML output * * Copyright 2009 April White * www - http://harbour-project.org * * Portions of this project are based on hbdoc * Copyright 1999-2003 Luiz Rafael Culik * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2, or (at your option) * any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this software; see the file COPYING.txt. If not, write to * the Free Software Foundation, Inc., 59 Temple Place, Suite 330, * Boston, MA 02111-1307 USA (or visit the web site http://www.gnu.org/). * * As a special exception, the Harbour Project gives permission for * additional uses of the text contained in its release of Harbour. * * The exception is that, if you link the Harbour libraries with other * files to produce an executable, this does not by itself cause the * resulting executable to be covered by the GNU General Public License. * Your use of that executable is in no way restricted on account of * linking the Harbour library code into it. * * This exception does not however invalidate any other reasons why * the executable file might be covered by the GNU General Public License. * * This exception applies only to the code released by the Harbour * Project under the name Harbour. If you copy code from other * Harbour Project or Free Software Foundation releases into a copy of * Harbour, as the General Public License permits, the exception does * not apply to the code that you add in this way. To avoid misleading * anyone as to the status of such modified files, you must delete * this exception notice from them. * * If you write modifications of your own for Harbour, it is your choice * whether to permit this exception to apply to your modifications. * If you do not wish that, delete this exception notice. * */ #include "hbclass.ch" #include "hbdoc.ch" #ifdef __PLATFORM__DOS # define EXTENSION ".htm" #else # define EXTENSION ".html" #endif #define STYLEFILE "hbdoc.css" CREATE CLASS GenerateHTML2 FROM GenerateHTML METHOD NewIndex( cFolder, cFilename, cTitle ) METHOD NewDocument( cFolder, cFilename, cTitle ) ENDCLASS METHOD NewDocument( cFolder, cFilename, cTitle ) CLASS GenerateHTML2 ::super:NewDocument( cFolder, cFilename, cTitle, EXTENSION ) RETURN self METHOD NewIndex( cFolder, cFilename, cTitle ) CLASS GenerateHTML2 ::super:NewIndex( cFolder, cFilename, cTitle, EXTENSION ) RETURN self CREATE CLASS GenerateHTML FROM TPLGenerate HIDDEN: METHOD RecreateStyleDocument( cStyleFile ) METHOD OpenTag( cText, ... ) METHOD Tagged( cText, cTag, ... ) METHOD CloseTag( cText ) METHOD Append( cText, cFormat ) METHOD Newline() INLINE FWrite( ::nHandle, "
" + hb_eol() ), self CLASS VAR lCreateStyleDocument AS LOGICAL INIT .T. VAR TargetFilename AS STRING INIT "" EXPORTED: METHOD NewFile() HIDDEN METHOD NewIndex( cFolder, cFilename, cTitle ) METHOD NewDocument( cFolder, cFilename, cTitle ) METHOD AddEntry( oEntry ) METHOD AddReference( oEntry, cReference, cSubReference ) METHOD BeginSection( cSection, cFilename ) METHOD EndSection( cSection, cFilename ) METHOD Generate() METHOD WriteEntry( cField, oEntry, lPreformatted, nIndent ) HIDDEN ENDCLASS METHOD NewFile() CLASS GenerateHTML FWrite( ::nHandle, "" + hb_eol() ) ::OpenTag( "html", "xmlns", "http://www.w3.org/1999/xhtml", "lang", "en" ) ::OpenTag( "head" ) ::Append( ::cTitle /* + iif( Empty( ::cDescription ), "", " - " + ::cDescription ) */, "title" ) ::OpenTag( "meta", "http-equiv", "content-type", "content", "text/html; charset=UTF-8" ) ::CloseTag( "meta" ) ::OpenTag( "meta", "name", "generator", "content", "Harbour examples/hbdoc" ) ::CloseTag( "meta" ) ::OpenTag( "meta", "name", "keywords", "content", "Harbour project, Clipper, xBase, database, Free Software, GNU, compiler, cross platform, 32-bit, FiveWin" ) ::CloseTag( "meta" ) IF ::lCreateStyleDocument ::lCreateStyleDocument := .F. ::RecreateStyleDocument( STYLEFILE ) ENDIF ::OpenTag( "link", "rel", "stylesheet", "type", "text/css", "href", STYLEFILE ) ::CloseTag( "link" ) ::CloseTag( "head" ) ::OpenTag( "body" ) ::Append( ::cTitle, "h1" ) RETURN self METHOD NewDocument( cFolder, cFilename, cTitle ) CLASS GenerateHTML ::super:NewDocument( cFolder, cFilename, cTitle, EXTENSION ) ::NewFile() RETURN self METHOD NewIndex( cFolder, cFilename, cTitle ) CLASS GenerateHTML ::super:NewIndex( cFolder, cFilename, cTitle, EXTENSION ) ::NewFile() RETURN self METHOD BeginSection( cSection, cFilename ) CLASS GenerateHTML IF ::IsIndex() IF cFilename == ::cFilename ::OpenTag( "div", "id", cSection ):Append( cSection, "h" + hb_ntos( ::Depth + 2 ) ):CloseTag( "div" )// :Newline() ELSE ::OpenTag( "a", "href", cFilename + ::cExtension + "#" + cSection ):Append( cSection, "h" + hb_ntos( ::Depth + 2 ) ):CloseTag( "a" )// :Newline() ENDIF ELSE ::OpenTag( "div", "id", cSection ):Append( cSection, "h" + hb_ntos( ::Depth + 2 ) ):CloseTag( "div" )// :Newline() ENDIF ::TargetFilename := cFilename ::Depth++ RETURN self METHOD EndSection( cSection, cFilename ) CLASS GenerateHTML HB_SYMBOL_UNUSED( cSection ) HB_SYMBOL_UNUSED( cFilename ) ::Depth-- RETURN self METHOD AddReference( oEntry, cReference, cSubReference ) CLASS GenerateHTML IF HB_ISOBJECT( oEntry ) .AND. oEntry:ClassName() == "ENTRY" ::OpenTag( "a", "href", ::TargetFilename + ::cExtension + "#" + oEntry:Filename ):Append( oEntry:Name ):CloseTag( "a" ):Append( oEntry:OneLiner ):Newline() ELSE IF cSubReference == NIL ::OpenTag( "a", "href", cReference + ::cExtension /* + "#" + oEntry:Filename */ ):Append( oEntry ):CloseTag( "a" ):Newline() ELSE ::OpenTag( "a", "href", cReference + ::cExtension + "#" + cSubReference ):Append( oEntry ):CloseTag( "a" ):Newline() ENDIF ENDIF RETURN self METHOD AddEntry( oEntry ) CLASS GenerateHTML LOCAL idx FOR idx := 1 TO Len( oEntry:Fields ) IF oEntry:Fields[ idx ][ 1 ] == "NAME" ::OpenTag( "div", "id", oEntry:filename ):OpenTag( "h4" ):Append( oEntry:Name ):CloseTag( "h4" ):CloseTag( "div" ) ELSEIF oEntry:IsField( oEntry:Fields[ idx ][ 1 ] ) .AND. oEntry:IsOutput( oEntry:Fields[ idx ][ 1 ] ) .AND. Len( oEntry:&( oEntry:Fields[ idx ][ 1 ] ) ) > 0 ::WriteEntry( oEntry:Fields[ idx ][ 1 ], oEntry, oEntry:IsPreformatted( oEntry:Fields[ idx ][ 1 ] ) ) ENDIF NEXT RETURN self METHOD Generate() CLASS GenerateHTML IF ! Empty( ::nHandle ) ::CloseTag( "body" ) ::CloseTag( "html" ) FClose( ::nHandle ) ::nHandle := 0 ENDIF RETURN self METHOD PROCEDURE WriteEntry( cField, oEntry, lPreformatted, nIndent ) CLASS GenerateHTML LOCAL cCaption := oEntry:FieldName( cField ) LOCAL cEntry := oEntry:&( cField ) // TODO: change this to search the CSS document itself LOCAL cTagClass := iif( Lower( cField ) + "|" $ "name|oneliner|examples|tests|", Lower( cField ), "itemtext" ) IF ! Empty( cEntry ) hb_default( @cCaption, "" ) hb_default( @nIndent, 0 ) // ~ hb_default( @lPreformatted, .F. ) // ~ hb_default( @cTagClass, "itemtext" ) IF Len( cCaption ) > 0 /* .AND. nIndent > 0 */ ::Tagged( cCaption, "div", "class", "itemtitle" ) ENDIF IF lPreformatted ::OpenTag( "pre", iif( cTagClass != NIL, "class", ), cTagClass ) DO WHILE Len( cEntry ) > 0 IF Lower( cField ) + "|" $ "examples|tests|" ::Append( SubStr( Parse( @cEntry, hb_eol() ), 5 ), "" ) ELSE ::Append( Indent( Parse( @cEntry, hb_eol() ), 0, , .T. ), "" ) ENDIF // ~ IF Len( cEntry ) > 0 .AND. ! lPreformatted // ~ FWrite( ::nHandle, hb_eol() ) // ~ ENDIF ENDDO ::CloseTag( "pre" ) ELSE DO WHILE Len( cEntry ) > 0 ::OpenTag( "div", "class", cTagClass ) ::Append( Indent( Parse( @cEntry, hb_eol() ), 0, 70 ), "" ):Newline() ::CloseTag( "div" ) ENDDO ENDIF ENDIF METHOD OpenTag( cText, ... ) CLASS GenerateHTML LOCAL aArgs := hb_AParams() LOCAL cTag := cText LOCAL idx FOR idx := 2 TO Len( aArgs ) STEP 2 cTag += " " + aArgs[ idx ] + "=" + '"' + aArgs[ idx + 1 ] + '"' NEXT FWrite( ::nHandle, "<" + cTag + ">" + hb_eol() ) RETURN self METHOD Tagged( cText, cTag, ... ) CLASS GenerateHTML LOCAL aArgs := hb_AParams() LOCAL cResult := "<" + cTag LOCAL idx FOR idx := 3 TO Len( aArgs ) STEP 2 cResult += " " + aArgs[ idx ] + "=" + '"' + aArgs[ idx + 1 ] + '"' NEXT FWrite( ::nHandle, cResult + ">" + cText + "" + /* "4" + */ hb_eol() ) RETURN self METHOD CloseTag( cText ) CLASS GenerateHTML FWrite( ::nHandle, "" + hb_eol() ) IF cText == "html" FClose( ::nHandle ) ::nHandle := 0 ENDIF RETURN self METHOD Append( cText, cFormat ) CLASS GenerateHTML LOCAL cResult := cText LOCAL aFormat LOCAL idx IF Len( cResult ) > 0 hb_default( @cFormat, "" ) aFormat := p_aConversionList FOR idx := 1 TO Len( aFormat ) STEP 2 cResult := StrTran( cResult, aFormat[ idx ], "&" + aFormat[ idx + 1 ] + ";" ) NEXT aFormat := hb_ATokens( cFormat, "," ) FOR idx := Len( aFormat ) TO 1 STEP -1 IF ! Empty( aFormat[ idx ] ) cResult := "<" + aFormat[ idx ] + ">" + cResult + "" ENDIF NEXT DO WHILE Right( cResult, Len( hb_eol() ) ) == hb_eol() cResult := Left( cResult, Len( cResult ) - Len( hb_eol() ) ) ENDDO FWrite( ::nHandle, cResult + hb_eol() ) ENDIF RETURN self METHOD RecreateStyleDocument( cStyleFile ) CLASS GenerateHTML LOCAL cString #pragma __streaminclude "hbdoc.css" | cString := %s IF ! hb_MemoWrit( ::cFolder + hb_ps() + cStyleFile, cString ) // TODO: raise an error, could not create style file ENDIF RETURN self