/* * $Id$ */ /* * Harbour Project source code: * Gentrf support module for hbdoc document Extractor * * Copyright 2000 Luiz Rafael Culik * www - http://www.harbour-project.org * * 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. 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. * */ #ifdef __HARBOUR__ #define NANFOR #endif #include "directry.ch" #include "fileio.ch" #include "inkey.ch" // output lines on the screen #define INFILELINE 10 #define MODULELINE 12 #define LINELINE 14 #define ERRORLINE 20 #define LONGLINE 100 #define LONGONELINE 86 #define CRLF HB_OSNewLine() // The delimiter #define DELIM "$" // keyword delimiter #xtranslate UPPERLOWER() => (UPPER(SUBSTR(,1,1))+LOWER(SUBSTR(,2))) MEMVAR aDirlist MEMVAR aDocInfo STATIC aAlso *+±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±± *+ *+ Function ProcessTroff() *+ *+ Called from ( hbdoc.prg ) 2 - function main() *+ *+±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±± *+ FUNCTION ProcessTroff // // Copyright (C) 2000 Luiz Rafael Culik // // Purpose: Process each of the files in the directory // and generate .tr file format output // Modification History: // Version Date Who Notes // V1.00 1/06/2000 LRC Initial Version // // Calling parameters: None // // Notes: None // - // LOCAL variables: #define D_NORMAL 1 #define D_ARG 2 #define D_SYNTAX 3 #define D_IGNORE 4 #define D_SEEALSO 5 #define D_INCLUDE 6 #define D_ONELINE 7 #define D_STATUS 8 LOCAL i LOCAL j LOCAL nFiles := LEN( aDirList ) LOCAL nCommentLen LOCAL lEof LOCAL lDoc LOCAL cBuffer LOCAL nEnd LOCAL nCount LOCAL cBar := "ÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ" LOCAL nMode LOCAL cFuncName LOCAL cOneLine LOCAL cCategory LOCAL cFileName LOCAL nLineCnt LOCAL cSeeAlso LOCAL cTemp LOCAL cChar LOCAL lBlankLine := .F. // Blank line encountered and sent out LOCAL lAddBlank := .F. // Need to add a blank line if next line is not blank LOCAL nAlso LOCAL oTroff LOCAL nReadHandle LOCAL cDoc := DELIM + "DOC" + DELIM // DOC keyword LOCAL cEnd := DELIM + "END" + DELIM // END keyword LOCAL cFunc := DELIM + "FUNCNAME" + DELIM // FUNCNAME keyword LOCAL cCat := DELIM + "CATEGORY" + DELIM // CATEGORY keyword LOCAL cOne := DELIM + "ONELINER" + DELIM // ONELINER keyword LOCAL cSyn := DELIM + "SYNTAX" + DELIM // SYNTAX keyword LOCAL cArg := DELIM + "ARGUMENTS" + DELIM // ARGUMENTS keyword LOCAL cRet := DELIM + "RETURNS" + DELIM // RETURNS keyword LOCAL cDesc := DELIM + "DESCRIPTION" + DELIM // DESCRIPTION keyword LOCAL cExam := DELIM + "EXAMPLES" + DELIM // EXAMPLES keyword LOCAL cSee := DELIM + "SEEALSO" + DELIM // SEEALSO keyword LOCAL cInc := DELIM + "INCLUDE" + DELIM // INCLUDE keyword LOCAL cComm := DELIM + "COMMANDNAME" + DELIM // COMMAND keyword LOCAL cCompl := DELIM + "COMPLIANCE" + DELIM LOCAL cTest := DELIM + 'TESTS' + DELIM LOCAL cStatus := DELIM + 'STATUS' + DELIM LOCAL cPlat := DELIM + 'PLATFORMS' + DELIM LOCAL cFiles := DELIM + 'FILES' + DELIM LOCAL cSubCode := DELIM + 'SUBCODE' + DELIM LOCAL cFunction := DELIM + 'FUNCTION' + DELIM // // Entry Point // // Put up information labels @ INFILELINE, 20 SAY "Extracting: " @ MODULELINE, 20 SAY "Documenting: " // loop through all of the files FOR i := 1 TO nFiles // Open file for input nCommentLen := IIF( AT( ".ASM", UPPER( aDirList[ i, F_NAME ] ) ) > 0, 2, 3 ) nReadHandle := FT_FUSE( aDirList[ i, F_NAME ] ) @ INFILELINE, 33 CLEAR TO INFILELINE, MAXCOL() @ INFILELINE, 33 SAY PAD( aDirList[ i, F_NAME ], 47 ) @ MODULELINE, 33 CLEAR TO LINELINE, MAXCOL() @ LINELINE, 27 SAY "Line:" nLineCnt := 0 IF nReadHandle < 0 WRITE_ERROR( "Can't open file: (Dos Error " + STR( FERROR() ) + ")",,,, aDirList[ i, F_NAME ] ) @ ERRORLINE, 0 CLEAR TO ERRORLINE, MAXCOL() @ ERRORLINE, 20 SAY "Can't open file: (Dos Error " + STR( FERROR() ) + ") File=" + aDirList[ i, F_NAME ] LOOP ENDIF lEof := .F. lDoc := .F. // First find the author DO WHILE .NOT. lEof // Read a line cBuffer := TRIM( SUBSTR( ReadLN( @lEof ), nCommentLen ) ) nLineCnt ++ IF nLineCnt % 10 = 0 @ LINELINE, 33 SAY STR( nLineCnt, 5, 0 ) ENDIF // check to see if we are in doc mode or getting out of doc mode IF AT( cDoc, cBuffer ) > 0 IF lDoc WRITE_ERROR( cDoc + " encountered during extraction of Doc" ; + " at line" + STR( nLinecnt, 5, 0 ),,,, aDirList[ i, F_NAME ] ) ENDIF lDoc := .T. cBuffer := TRIM( SUBSTR( ReadLN( @lEof ), ; nCommentLen ) ) nLineCnt ++ cCategory := cFuncName := cSeeAlso := "" nMode := D_IGNORE ELSEIF AT( cEnd, cBuffer ) > 0 IF .NOT. lDoc WRITE_ERROR( cEnd + " encountered outside of Doc area at line" ; + STR( nLinecnt, 5, 0 ),,,, aDirList[ i, F_NAME ] ) ELSE // Add a new entry to our list of files IF EMPTY( cCategory ) WRITE_ERROR( "Blank Category",,,, aDirList[ i, F_NAME ] ) cCategory := "Unknown" ENDIF IF EMPTY( cFuncName ) WRITE_ERROR( "Blank Function Name",,,, aDirList[ i, F_NAME ] ) cFuncName := "Unknown" ENDIF AADD( aDocInfo, { cCategory, cFuncName, cOneLine, cFileName } ) // Now close down this little piece lDoc := .F. IF .NOT. EMPTY( cSeeAlso ) oTroff:WriteText( '.ft B' + CRLF + "See Also:" + CRLF + '.ft R' ) FOR nAlso := 1 TO LEN( aAlso ) IF nAlso == 1 oTroff:WriteLink( aalso[ nAlso ] ) ELSE oTroff:WriteLink( "," + aalso[ nAlso ] ) ENDIF NEXT ENDIF otroff:Close() nMode := D_IGNORE ENDIF @ MODULELINE, 33 CLEAR TO MODULELINE, MAXCOL() ENDIF // Act on the input IF lDoc // 1) function name IF AT( cFunc, cBuffer ) > 0 .OR. AT( cComm, cBuffer ) > 0 .OR. AT( cSubCode, cBuffer ) > 0 cBuffer := ReadLN( @lEof ) nLineCnt ++ // Save the function name cFuncName := UPPER( ALLTRIM( SUBSTR( cBuffer, nCommentLen ) ) ) @ MODULELINE, 33 CLEAR TO MODULELINE, MAXCOL() @ MODULELINE, 33 SAY cFuncName nMode := D_NORMAL // Open a new file IF AT( "FT_", cFuncName ) > 0 cTemp := SUBSTR( cFuncName, 4 ) ELSE cTemp := cFuncName ENDIF IF ( nEnd := AT( "(", cTemp ) ) > 0 cTemp := LEFT( cTemp, nEnd - 1 ) ENDIF cFileName := "" // Strip off any other non-alphabetic/numeric characters FOR j := 1 TO LEN( cTemp ) cChar := SUBSTR( cTemp, j, 1 ) IF ( cChar >= "0" .AND. cChar <= "9" ) .OR. ; ( cChar >= "A" .AND. cChar <= "Z" ) .OR. cChar = "_" cFileName += cChar ENDIF NEXT // See if file name is present already. If so then modify cFileName := LEFT( cFileName, 21 ) nEnd := 1 nCount := 0 DO WHILE nEnd > 0 nEnd := ASCAN( aDocInfo, { | a | a[ 4 ] == cFileName + ".tr" } ) IF nEnd > 0 // This will break if there are more than 10 files with the same first // seven characters. We take our chances. IF LEN( cFileName ) = 21 cFileName := STUFF( cFileName, 21, 1, STR( nCount, 1, 0 ) ) ELSE cFileName += STR( nCount, 1, 0 ) ENDIF nCount ++ ENDIF ENDDO // Add on the extension cFileName := LEFT( cFileName, 21 ) + ".tr" otroff := tTroff():new( "tr\" + cFileName ) IF otroff:nHandle < 1 ? "Error creating", cFileName, ".tr" WRITE_ERROR( "Error creating",,,, cFileName + ".tr" ) ENDIF // 2) Category ELSEIF AT( cCat, cBuffer ) > 0 cBuffer := ReadLN( @lEof ) nLineCnt ++ // get the category cCategory := UPPER( ALLTRIM( SUBSTR( cBuffer, nCommentLen ) ) ) // 3) One line description ELSEIF AT( cOne, cBuffer ) > 0 cBuffer := ReadLN( @lEof ) nLineCnt ++ cOneLine := ALLTRIM( SUBSTR( cBuffer, nCommentLen ) ) IF LEN( cOneLine ) > LONGONELINE WRITE_ERROR( "OneLine", cOneLine, nLineCnt, LONGONELINE, ; aDirList[ i, F_NAME ] ) ENDIF nMode := D_ONELINE // Now start writing out what we know otroff:WriteTitle( PAD( cFuncName, 21 ), cFuncName ) otroff:WriteParBold( cOneLine ) // 4) all other stuff ELSE IF AT( cSyn, cBuffer ) > 0 otroff:WriteParBold( " Syntax" ) nMode := D_SYNTAX lAddBlank := .T. ELSEIF AT( cArg, cBuffer ) > 0 IF !lBlankLine otroff:WriteParBold( " Arguments" ) ENDIF nMode := D_ARG lAddBlank := .T. ELSEIF AT( cRet, cBuffer ) > 0 IF !lBlankLine oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) ENDIF otroff:WriteParBold( " Returns" ) nMode := D_ARG lAddBlank := .T. ELSEIF AT( cDesc, cBuffer ) > 0 IF !lBlankLine oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) ENDIF otroff:WriteParBold( " Description" ) nMode := D_NORMAL lAddBlank := .T. ELSEIF AT( cExam, cBuffer ) > 0 IF !lBlankLine oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) ENDIF otroff:WriteParBold( " Examples" ) nMode := D_NORMAL lAddBlank := .T. ELSEIF AT( cTest, cBuffer ) > 0 IF !lBlankLine oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) ENDIF otroff:WriteParBold( " Tests" ) nMode := D_NORMAL lAddBlank := .T. ELSEIF AT( cStatus, cBuffer ) > 0 nMode := D_STATUS ELSEIF AT( cCompl, cBuffer ) > 0 IF !lBlankLine oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) ENDIF otroff:WriteParBold( " Compliance" ) nMode := D_NORMAL lAddBlank := .T. ELSEIF AT( cPlat, cBuffer ) > 0 IF !lBlankLine oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) ENDIF otroff:WriteParBold( " Platforms" ) nMode := D_NORMAL lAddBlank := .T. ELSEIF AT( cFiles, cBuffer ) > 0 IF !lBlankLine oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) ENDIF otroff:WriteParBold( " Files" ) nMode := D_NORMAL lAddBlank := .T. ELSEIF AT( cSee, cBuffer ) > 0 nMode := D_SEEALSO ELSEIF AT( cInc, cBuffer ) > 0 nMode := D_INCLUDE // All other input is trimmed of comments and sent out ELSE // translate any \$ into $ cBuffer := STRTRAN( cBuffer, "\" + DELIM, DELIM ) IF nMode = D_SYNTAX IF LEN( cBuffer ) > LONGLINE WRITE_ERROR( "Syntax", cBuffer, nLineCnt, ; LONGLINE, aDirList[ i, F_NAME ] ) ENDIF lBlankLine := EMPTY( cBuffer ) IF lAddBlank oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) lAddBlank := .F. ENDIF /* nNonBlank:=FirstNB(cBuffer) cBuffer=STUFF(cBuffer,nNonBlank,0,"^a1f ")*/ otroff:WritePar( cBuffer ) ELSEIF nMode = D_ARG IF LEN( cBuffer ) > LONGLINE WRITE_ERROR( "Arguments", cBuffer, nLineCnt, ; LONGLINE, aDirList[ i, F_NAME ] ) ENDIF lBlankLine := EMPTY( cBuffer ) IF lAddBlank oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) lAddBlank := .F. ENDIF cBuffer := STRTRAN( cBuffer, "<", "<", 1 ) cBuffer := STRTRAN( cBuffer, ">", ">", 1 ) otroff:WritePar( StripNgControls( cBuffer ) ) ELSEIF nMode = D_NORMAL IF LEN( cBuffer ) > LONGLINE WRITE_ERROR( "General", cBuffer, nLineCnt, ; LONGLINE, aDirList[ i, F_NAME ] ) ENDIF lBlankLine := EMPTY( cBuffer ) IF lAddBlank oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) lAddBlank := .F. ENDIF otroff:WritePar( StripNgControls( cBuffer ) ) ELSEIF nMode = D_SEEALSO IF .NOT. EMPTY( cBuffer ) cSeeAlso := ProcTroffAlso( StripFiles( ALLTRIM( cBuffer ) ) ) ENDIF ELSEIF nMode = D_INCLUDE // read next line IF .NOT. EMPTY( cBuffer ) IF !lBlankLine oTroff:WriteText( ".sp" + CRLF + ".in 0.4i" ) ENDIF otroff:WritePar( " Header File: " ; + ALLTRIM( cBuffer ) ) ENDIF ELSEIF nMode = D_STATUS IF !EMPTY( cBuffer ) otroff:WriteParBold( "Status" ) ENDIF ProcStatusTroff( otroff, cBuffer ) ELSE // unknown data from somewhere WRITE_ERROR( "Unknown Data Type " + cBuffer,, ; nLineCnt, ; LONGONELINE, aDirList[ i, F_NAME ] ) ENDIF ENDIF ENDIF ENDIF ENDDO // Close down the input file FT_FUSE() NEXT RETURN NIL *+±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±± *+ *+ Function ProcTroffAlso() *+ *+ Called from ( gentrf.prg ) 1 - function processtroff() *+ *+±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±± *+ FUNCTION ProcTroffAlso( cSeealso ) aAlso := {} aAlso := ListAsArray2( cSeealso, "," ) RETURN aAlso *+±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±± *+ *+ Function ProcStatusTroff() *+ *+ Called from ( gentrf.prg ) 1 - function processtroff() *+ *+±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±±± *+ FUNCTION ProcStatusTroff( nWriteHandle, cBuffer ) IF LEN( ALLTRIM( cBuffer ) ) > 1 nWriteHandle:WritePar( cBuffer ) ELSEIF SUBSTR( ALLTRIM( cBuffer ), 1 ) == "R" nWriteHandle:WritePar( " Ready" ) ELSEIF SUBSTR( ALLTRIM( cBuffer ), 1 ) == "S" nWriteHandle:WritePar( " Started" ) ELSE nWriteHandle:WritePar( " Not Started" ) ENDIF RETURN nil *+ EOF: GENTRF.PRG