ZICDOC - HTML documentation generator for ABAP programs - part II

[Former Member]

Installation

ATTENTION!
Due to size limit of single Weblog, I had to put source code of programs in parts II, III and IV of the blog.

The first part: ZICDOC - HTML documentation generator for ABAP programs - part I

This post is the second part of WeBlog describing ZICDOC - generator of HTML description of ABAP program.

I tried not to use any nonstandard dictionary objects. You can even find, that I haven't used program text for HTML tags, but created them as constants. So, it should be enough just to create all ABAP programs and then activate them. If you want to understand what fields are on selection screen of the main program, copy texts from source code (they are at the beginning ) to selection texts.

Additionally, you have to create local file ZIcDocStyle.css and paste into it content from the field below:

    BODY {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: x-small;        }    H1 {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: 160%;          font-weight: bold;          padding-top: 10pt;          padding-bottom: 10pt;      }    H2 {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: 160%;          font-weight: bold;          padding-top: 8pt;          padding-bottom: 8pt;          border-top: medium double;          border-bottom: medium double;          border-left: medium double;          border-right: medium double;          background-color: lightsteelblue;      }    H3 {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: 140%;          font-weight: bold;          padding-top: 5pt;          padding-bottom: 5pt;          border-top: medium double;          border-bottom: medium double;          border-left: medium double;          border-right: medium double;          background-color: whitesmoke;      }    H4 {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: 120%;          font-weight: bold;          font-style: italic;          padding-top: 4pt;          padding-bottom: 4pt;      }    H5 {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: 110%;          font-weight: bold;          padding-top: 4pt;          padding-bottom: 4pt;      } <1-- Not used -->   H6 {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: 10pt;          font-weight: bold;          font-style: italic;          padding-top: 4pt;          padding-bottom: 4pt;      }    DFN {          font-family: "Courier New", "Courier", "monospace";          font-weight: bold;          font-style: normal;       }    SAMP {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: 90%;          font-style: italic;        }   CODE {          font-family: "Courier New", "Courier", "monospace";          font-size: 100%;        }   VAR {          font-family: "Courier New", "Courier", "monospace";          font-size: 100%;          font-style: italic;       }   DT {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-weight: bold;      }   DD {          font-family: "Verdana", "Arial", "Helvetica", "sans-serif";          font-size: 110%;      }   TD SAMP {          width: 25ex;           }   TD.dbname {          width: 20ex;             }   TD.dbaccess {          width: 15ex;               }

You should create the following programs:

• ZICDOC - the main program (type ‘1') of the generator. It is ready-to-use program or just example how to call generator from other programs.
• ZICDOC_CL_HTML - include (type ‘I') with class supporting creation of HTML file
• ZICDOC_CL_CODE_ANALYSIS - include containing class for source code analysis
• ZICDOC_CL_CODE_ANALYSIS_HTML - include with class analyzing code and creating HTML documentation

*&---------------------------------------------------------------------**& Report  ZICDOC*&*&---------------------------------------------------------------------** @Author Ireneusz Cwir* The main program of ZICDOC generator. It shows also how to call* program analysis and HTML file generation from other code.REPORT  zicdoc LINE-SIZE 256.* These texts are defined in properties of the program.* You can uncomment them (optionally) and copy to right fields.** Title (Goto -> Attributes)* ZICDOC - ABAP documentation generator** Selection parametrs (Goto -> Text elements -> Selection texts):*P_CCPRIV Private class components*P_CCPROT Protected class components*P_CLSCMP Class components*P_FHTML  Output file name (html)*P_FSRC Cource code file name*P_HTMLCM Comments include HTML tags*P_INCDET INCLUDES - details*P_INCHIE INCLUDES - hierarchy*P_PROG Analysed program name*P_TABLES Database tables*P_UNTDET Code units - details*P_UNTHIE Code units - hierarchyPARAMETERS: p_prog  LIKE trdir-name DEFAULT 'ZICDOC_TEST1',            p_fsrc  LIKE rlgrap-filename DEFAULT 'd: 22IC002.txt'.SELECTION-SCREEN SKIP 1.PARAMETERS: p_fhtml LIKE rlgrap-filename DEFAULT 'D: ICDOC_TEST1.html'.SELECTION-SCREEN SKIP 1.PARAMETERS: p_inchie AS CHECKBOX DEFAULT 'X',            p_incdet AS CHECKBOX DEFAULT 'X',            p_clscmp AS CHECKBOX DEFAULT 'X',            p_unthie AS CHECKBOX DEFAULT 'X',            p_untdet AS CHECKBOX DEFAULT 'X',            p_tables AS CHECKBOX DEFAULT 'X'.SELECTION-SCREEN SKIP 1.PARAMETERS: p_ccprot AS CHECKBOX DEFAULT 'X',            p_ccpriv AS CHECKBOX DEFAULT 'X'.SELECTION-SCREEN SKIP 1.PARAMETERS: p_htmlcm AS CHECKBOX DEFAULT 'X'.*----------------------------------------------------------------------* Include classe for code analysis and HTML file generationINCLUDE zicdoc_cl_code_analysis_html.*----------------------------------------------------------------------* Reference to the main objectof analysis.DATA: ref_html TYPE REF TO zcl_ic_code_analysis_html.* Additional dataDATA: gv_str TYPE string.DATA: gv_retcode TYPE i.*----------------------------------------------------------------------START-OF-SELECTION.* Create object for code analysis  CREATE OBJECT ref_html.* Depending on parameters entered on selection screen, call method for* anlysing code of program in the system or code uploaded* from local file (from presentation server or PC).  IF p_prog IS NOT INITIAL.    gv_retcode = ref_html->analyse_program( p_prog ).  ELSEIF p_fsrc IS NOT INITIAL.    gv_str = p_fsrc.    gv_retcode = ref_html->analyse_file( gv_str ).  ELSE.    WRITE:/ 'No program specified for analysis!'.    EXIT.  ENDIF.  IF gv_retcode <> 0.    WRITE:/ 'Scan ERROR:', gv_retcode.  ENDIF.  CHECK gv_retcode = 0.* Type conversion (output file name)  gv_str = p_fhtml.* Create HTML file with documentation.  CALL METHOD ref_html->write_html_file    EXPORTING      i_filename                    = gv_str      i_write_includes_hier         = p_inchie      i_write_includes_details      = p_incdet      i_write_class_components      = p_clscmp      i_write_class_components_prot = p_ccprot      i_write_class_components_priv = p_ccpriv      i_write_code_units_hier       = p_unthie      i_write_code_units_details    = p_untdet      i_write_tables                = p_tables      i_html_comments               = p_htmlcm    RECEIVING      ret_code                      = gv_retcode.* Helper function for displaying tables with results of code scanning.* Uncomment them if you are interested in further development of ZICDOC* and you want to understand details of the code analysis.*  CALL METHOD ref_html->dump_statements.*  CALL METHOD ref_html->dump_statements_detailed.*  CALL METHOD ref_html->dump_tables_scan. *&---------------------------------------------------------------------**&  Include           ZICDOC_CL_HTML*&---------------------------------------------------------------------** Contains helper methods for creating HTML file.CLASS zcl_ic_html DEFINITION.  PUBLIC SECTION.*   Table with content of HTML document (source text of document).    DATA: gt_content TYPE STANDARD TABLE OF string.    METHODS: constructor.    METHODS: reset.*   Returns string afetr conversion to HTML internal format*   (e.c. '<' is replaced by '<'    METHODS: str2html IMPORTING i_str TYPE string                      RETURNING value(e_str) TYPE string.*   Add string with or  without conversion to internal format    METHODS: add_string IMPORTING str TYPE string,             add_string_raw IMPORTING str TYPE string.*   Moves content of internal line buffer to document (like new line).    METHODS: flush_buffer.    METHODS: add_tag_start IMPORTING tag TYPE string,             add_tag_end IMPORTING tag TYPE string,             add_tag IMPORTING tag TYPE string str TYPE string.    METHODS: add_header1 IMPORTING str TYPE string,             add_header2 IMPORTING str TYPE string,             add_header3 IMPORTING str TYPE string,             add_header4 IMPORTING str TYPE string,             add_header5 IMPORTING str TYPE string,             add_header6 IMPORTING str TYPE string,             add_paragraph IMPORTING str TYPE string,             add_line_break,             add_blank_line.*   Returns string (str...) or appends (add...) tag elements*   for links inside document. a_name is an anchor on a page,*   a_href is a refernce to an anchor. i_label must be unique*   identifier of an anchor. i_text is a text displayed as a reference.    METHODS: str_a_href IMPORTING i_label TYPE string                                  i_text TYPE string                        RETURNING value(e_str) TYPE string,             str_a_name IMPORTING i_label TYPE string                                  i_text TYPE string                        RETURNING value(e_str) TYPE string,             add_a_href IMPORTING i_label TYPE string                                  i_text TYPE string,             add_a_name IMPORTING i_label TYPE string                                  i_text TYPE string.*   Starts new document - place several tags    METHODS: start_document IMPORTING i_title TYPE string                                      i_code_page TYPE string                                      i_css_file_name TYPE string                                      i_comment TYPE string,             end_document.*   Writes HTML document to disk    METHODS: write_file IMPORTING file_name TYPE string                        RETURNING value(ret_code) TYPE i.  PRIVATE SECTION.    DATA: lv_buffer TYPE string.ENDCLASS.                    "zcl_ic_html DEFINITION*----------------------------------------------------------------------**       CLASS zcl_ic_html IMPLEMENTATION*----------------------------------------------------------------------*CLASS zcl_ic_html IMPLEMENTATION.  METHOD constructor.    CALL METHOD reset.  ENDMETHOD.                    "constructor  METHOD reset.    REFRESH: gt_content.    CLEAR: lv_buffer.  ENDMETHOD.                    "reset  METHOD add_tag_start.    CONCATENATE lv_buffer '<' tag '>' INTO lv_buffer.  ENDMETHOD.                    "add_tag_start  METHOD add_tag_end.    CONCATENATE lv_buffer '</' tag '>' INTO lv_buffer.  ENDMETHOD.                    "add_tag_end  METHOD add_tag.    CALL METHOD flush_buffer.    CALL METHOD add_tag_start( tag ).    CALL METHOD add_string( str ).    CALL METHOD add_tag_end( tag ).    CALL METHOD flush_buffer.  ENDMETHOD.                    "add_tag  METHOD str2html.    DATA: str TYPE string,          len TYPE i, cur TYPE i, cnt TYPE i,          off1 TYPE i,          lv_char TYPE c, lv_spec(20) TYPE c.    off1 = 0.    len = STRLEN( i_str ).    DO len TIMES.      cur = sy-index - 1.      lv_char = i_str+cur(1).      CASE lv_char.        WHEN '<'.          lv_spec = '<'.        WHEN '>'.          lv_spec = '>'.        WHEN '&'.          lv_spec = '&'.        WHEN '|'.          lv_spec = '¦'.        WHEN '~'.          lv_spec = '˜'.        WHEN OTHERS.          IF sy-index = len.   " last char            lv_spec = lv_char.          ELSE.            lv_spec = space.          ENDIF.      ENDCASE.      IF lv_spec <> space.        cnt = cur - off1.        CONCATENATE str i_str+off1(cnt) lv_spec INTO str.        off1 = sy-index.      ENDIF.    ENDDO.    e_str = str.  ENDMETHOD.                                                "str2html  METHOD add_string.    DATA: txt TYPE string.    txt = str2html( str ).    CONCATENATE lv_buffer txt INTO lv_buffer.  ENDMETHOD.                    "add_string  METHOD add_string_raw.    CONCATENATE lv_buffer str INTO lv_buffer.  ENDMETHOD.                    "add_string_raw  METHOD flush_buffer.    IF NOT lv_buffer IS INITIAL.      APPEND lv_buffer TO gt_content.      CLEAR: lv_buffer.    ENDIF.  ENDMETHOD.                    "flush_buffer  METHOD add_header1.    CALL METHOD add_tag      EXPORTING        tag = 'h1'        str = str.  ENDMETHOD.                    "append_header1  METHOD add_header2.    CALL METHOD add_tag      EXPORTING        tag = 'h2'        str = str.  ENDMETHOD.                    "append_header2  METHOD add_header3.    CALL METHOD add_tag      EXPORTING        tag = 'h3'        str = str.  ENDMETHOD.                    "append_header3  METHOD add_header4.    CALL METHOD add_tag      EXPORTING        tag = 'h4'        str = str.  ENDMETHOD.                    "add_header4  METHOD add_header5.    CALL METHOD add_tag      EXPORTING        tag = 'h5'        str = str.  ENDMETHOD.                    "add_header5  METHOD add_header6.    CALL METHOD add_tag      EXPORTING        tag = 'h6'        str = str.  ENDMETHOD.                    "add_header6  METHOD add_paragraph.    CALL METHOD add_tag      EXPORTING        tag = 'p'        str = str.  ENDMETHOD.                    "append_paragraph  METHOD add_line_break.    CALL METHOD add_string_raw( '' ).  ENDMETHOD.                    "append_line_break  METHOD add_blank_line.    CALL METHOD add_string_raw( '' ). ENDMETHOD. METHOD str_a_href. e_str = str2html( i_text ). CONCATENATE '' e_str '' INTO e_str. ENDMETHOD. "str_a_href METHOD str_a_name. e_str = str2html( i_text ). CONCATENATE '' e_str '' INTO e_str. ENDMETHOD. "str_a_name METHOD add_a_href. DATA: str TYPE string. str = str2html( i_text ). CONCATENATE '' str '' INTO str. CALL METHOD add_string_raw( str ). ENDMETHOD. "add_a_href METHOD add_a_name. DATA: str TYPE string. str = str2html( i_text ). CONCATENATE '' str '' INTO str. CALL METHOD add_string_raw( str ). ENDMETHOD. "add_a_name METHOD start_document. DATA: l_str TYPE string. CALL METHOD add_string_raw( '' ). CALL METHOD flush_buffer. CALL METHOD add_string_raw( '' ). CALL METHOD flush_buffer. CONCATENATE '' INTO l_str. CALL METHOD add_string_raw( l_str ). CALL METHOD flush_buffer. IF i_css_file_name IS NOT INITIAL. CONCATENATE '' INTO l_str. CALL METHOD add_string_raw( l_str ). CALL METHOD flush_buffer. ENDIF. IF i_comment IS NOT INITIAL. CALL METHOD add_string_raw( i_comment ). CALL METHOD flush_buffer. ENDIF. CALL METHOD add_tag EXPORTING tag = 'title' str = i_title. CALL METHOD add_string_raw( '' ). CALL METHOD flush_buffer. CALL METHOD add_string_raw( '' ). CALL METHOD flush_buffer. ENDMETHOD. "start_document METHOD end_document. CALL METHOD add_string_raw( '' ). CALL METHOD flush_buffer. CALL METHOD add_string_raw( '' ). CALL METHOD flush_buffer. ENDMETHOD. "end_document METHOD write_file. CALL METHOD flush_buffer. CALL FUNCTION 'GUI_DOWNLOAD' EXPORTING filename = file_name TABLES data_tab = gt_content EXCEPTIONS file_write_error = 1 no_batch = 2 gui_refuse_filetransfer = 3 invalid_type = 4 no_authority = 5 unknown_error = 6 header_not_allowed = 7 separator_not_allowed = 8 filesize_not_allowed = 9 header_too_long = 10 dp_error_create = 11 dp_error_send = 12 dp_error_write = 13 unknown_dp_error = 14 access_denied = 15 dp_out_of_memory = 16 disk_full = 17 dp_timeout = 18 file_not_found = 19 dataprovider_exception = 20 control_flush_error = 21 OTHERS = 22. ret_code = sy-subrc. ENDMETHOD. "write_file ENDCLASS. "zcl_ic_html IMPLEMENTATION