From 9379283d2968ea8137044fec44e3b7ac78af499a Mon Sep 17 00:00:00 2001 From: Pekka Riikonen Date: Sat, 11 Aug 2001 13:45:04 +0000 Subject: [PATCH] updates. --- lib/silcclient/DIRECTORY | 29 +++++++++++++++++++++++++++++ lib/silccore/DIRECTORY | 27 +++++++++++++++++++++++++++ scripts/silcdoc/silcdoc | 25 ++++++++++++++++++++++++- util/robodoc/Source/generator.c | 6 ++++++ util/robodoc/Source/items.c | 15 ++++++++------- util/robodoc/Source/items.h | 4 +++- 6 files changed, 97 insertions(+), 9 deletions(-) create mode 100644 lib/silcclient/DIRECTORY create mode 100644 lib/silccore/DIRECTORY diff --git a/lib/silcclient/DIRECTORY b/lib/silcclient/DIRECTORY new file mode 100644 index 00000000..5ff3a03e --- /dev/null +++ b/lib/silcclient/DIRECTORY @@ -0,0 +1,29 @@ + + +
    +SILC Client Library

    +Introduction

    +
    +SILC Client Library is SILC Client implementation without the actual user 
+interface. The library uses common and core components of SILC protocol from
+lib/silccore library and normal utility routines from lib/silcutil library.
+The library has been designed to be complete SILC Client implementation
+without actual user interface.  The library provides the API for the
+application which it can use to implement generally whatever user interface
+it wants.
+
+The `silcapi.h' file defines the function prototypes that application must
+implement in order to be able to create the user interface with the
+library.  The idea is that the application can implement whatever user
+interface routines in the functions and display the data whatever way
+it wants.  The library is entirely transparent to the user interface and
+it does not include any user interface specific issues such as window
+handling or item handling on the screen etc.  These does not interest
+the library.
+
    + +
  1. SILC Client API +
diff --git a/lib/silccore/DIRECTORY b/lib/silccore/DIRECTORY new file mode 100644 index 00000000..963eced5 --- /dev/null +++ b/lib/silccore/DIRECTORY @@ -0,0 +1,27 @@ + + +
    +SILC Core Library

    +Introduction

    +
    +SILC Core Library includes all the core components of the SILC Protocol.
+It provides routines to encode and decode all SILC packet payloads defined
+in the protocol specification.  It provides packet assembling and parsing
+routines, and routines for sending private message and channel messages.
+
    + +
  1. SILC Auth API +
  2. SILC Channel API +
  3. SILC Command API +
  4. SILC ID API +
  5. SILC ID Cache API +
  6. SILC Modes +
  7. SILC Notify API +
  8. SILC Packet API +
  9. SILC Payload API +
  10. SILC Private API +
  11. SILC Protocol API +
diff --git a/scripts/silcdoc/silcdoc b/scripts/silcdoc/silcdoc index 3ec14190..3aa46965 100755 --- a/scripts/silcdoc/silcdoc +++ b/scripts/silcdoc/silcdoc @@ -42,6 +42,7 @@ if [ "$TYPE" = "HTML" ]; then mkdir /tmp/silcdoc.html cp $headers /tmp/silcdoc.html + # Generate the actual detailed documentation path=`pwd` cd /tmp/silcdoc.html headers=`find . -name "silc*.h" |cut -d/ -f2 |cut -d. -f1` @@ -55,7 +56,7 @@ if [ "$TYPE" = "HTML" ]; then sh gen.sh index.php $DST/$i.html $DST/$i.html # Generate the details and the layour - files=`find $DST -name "$i_*.html"` + files=`find $DST -name ""$i"_*.html"` for k in $files do sh gen.sh gen_detail.php $k $k @@ -65,5 +66,27 @@ if [ "$TYPE" = "HTML" ]; then rm -f $DST/$i_index.tmpl done + # Generate the index and TOC files from the DIRECTORY files + files=`find $SRC -name "DIRECTORY"` + index=`find $SRC -name "INDEX"` + cat $index >$DST/index.html + for i in $files + do + # Get library name + name=`grep $i "@LIBRARY=" |cut -d= -f2` + fname=`grep $i "@FILENAME" |cut -d= -f2` + + # Generate the TOC file for the library + sh gen.sh gen_toc.php $i $DST/$fname + sh gen.sh index.php $DST/$fname $DST/$fname + + # Generate the link for the top index.html for this library + echo "
  • $name" >>$DST/index.html + done + + # Generate the top index.html file + sh gen.sh gen_toc.php $DST/index.html $DST/index.html + sh gen.sh index.php $DST/index.html $DST/index.html + rm -rf /tmp/silcdoc.html fi diff --git a/util/robodoc/Source/generator.c b/util/robodoc/Source/generator.c index 70c4c8c7..db013bc5 100644 --- a/util/robodoc/Source/generator.c +++ b/util/robodoc/Source/generator.c @@ -840,6 +840,9 @@ RB_Generate_Item_Doc (FILE * dest_doc, char *dest_name, if (item_attributes[item_type] & TEXT_BODY_SHINE) fprintf (dest_doc, format_str, att_start_command[MAKE_SHINE][output_mode]); + if (item_attributes[item_type] & TEXT_BODY_DEFAULT) + fprintf (dest_doc, format_str, + att_start_command[MAKE_DEFAULT][output_mode]); /* * For some modes, the text body is always non-prop @@ -893,6 +896,9 @@ RB_Generate_Item_Doc (FILE * dest_doc, char *dest_name, if (item_attributes[item_type] & TEXT_BODY_LARGE_FONT) fprintf (dest_doc, format_str, att_stop_command[MAKE_LARGE][output_mode]); + if (item_attributes[item_type] & TEXT_BODY_DEFAULT) + fprintf (dest_doc, format_str, + att_stop_command[MAKE_DEFAULT][output_mode]); if (output_mode != HTML) { diff --git a/util/robodoc/Source/items.c b/util/robodoc/Source/items.c index 747ee7a2..0415b3dd 100644 --- a/util/robodoc/Source/items.c +++ b/util/robodoc/Source/items.c @@ -104,7 +104,7 @@ long item_attributes[NUMBER_OF_ITEMS] = ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* SYNOPSIS_ITEM */ ITEM_NAME_LARGE_FONT, /* USAGE_ITEM */ ITEM_NAME_LARGE_FONT, /* FUNCTION_ITEM */ - ITEM_NAME_LARGE_FONT, /* DESCRIPTION_ITEM */ + ITEM_NAME_LARGE_FONT | TEXT_BODY_DEFAULT, /* DESCRIPTION_ITEM */ ITEM_NAME_LARGE_FONT, /* PURPOSE_ITEM */ ITEM_NAME_LARGE_FONT | TEXT_BODY_BOLD, /* AUTHOR_ITEM */ ITEM_NAME_LARGE_FONT | TEXT_BODY_BOLD, /* CREATION_DATE_ITEM */ @@ -129,7 +129,7 @@ long item_attributes[NUMBER_OF_ITEMS] = ITEM_NAME_LARGE_FONT, /* IDEAS_ITEM */ ITEM_NAME_LARGE_FONT, /* PORTABILITY_ITEM */ ITEM_NAME_LARGE_FONT, /* SEE_ALSO_ITEM */ - ITEM_NAME_LARGE_FONT, /* SOURCE_ITEM */ + ITEM_NAME_LARGE_FONT | TEXT_BODY_SHINE, /* SOURCE_ITEM */ ITEM_NAME_LARGE_FONT, /* METHODS_ITEM */ ITEM_NAME_LARGE_FONT, /* NEW_METHODS_ITEM */ ITEM_NAME_LARGE_FONT, /* ATTRIBUTES_ITEM */ @@ -166,7 +166,7 @@ char *item_attr_names[] = { /* "NORMAL", */ "LARGE", "ITALICS", "NONPROP", "SMALL", "BOLD", - "UNDERLINE", "SHINE", "HIGHLIGHT" + "UNDERLINE", "SHINE", "HIGHLIGHT", "DEFAULT", }; /*************/ @@ -176,15 +176,15 @@ char *item_attr_names[] = char *att_start_command[SIZE_ATTRIBUTES][SIZE_MODES] = { - {"", "@{b}", "", "{\\large ", "\\par\\fs28 "}, - /* Large Font */ + {"", "@{b}", "", "{\\large ", "\\par\\fs28 "}, /* Large Font */ {"", "@{i}", "", "{\\it ", "\\i1 "}, /* Italics. */ {"", "", "", "", ""}, /* NON-Proportional font. */ {"", "", "", "{\\small ", "\\fs16 "}, /* Small Font. */ {"", "@{b}", "", "{\\bf ", "\\b1 "}, /* Bold. */ {"", "@{u}", "", "\\underline{", "\\ul1 "}, /* Underline */ {"", "@{fg shine}", "", "{\\em ", ""},/* Shine */ - {"", "@{fg highlight}", "", "{\\em ", ""} /* Highlight */ + {"", "@{fg highlight}", "", "{\\em ", ""}, /* Highlight */ + {"", "", "", "", ""} /* Default */ }; char *att_stop_command[SIZE_ATTRIBUTES][SIZE_MODES] = @@ -196,7 +196,8 @@ char *att_stop_command[SIZE_ATTRIBUTES][SIZE_MODES] = {"", "@{ub}", "", "}", "\\b0 "}, /* Bold. */ {"", "@{uu}", "", "}", "\\ul0 "}, /* Underline */ {"", "@{fg text}", "", "}", ""}, /* Shine */ - {"", "@{fg text}", "", "}", ""} /* Highlight */ + {"", "@{fg text}", "", "}", ""}, /* Highlight */ + {"", "", "", "", ""} /* Normal */ }; diff --git a/util/robodoc/Source/items.h b/util/robodoc/Source/items.h index 738a6735..071c7689 100644 --- a/util/robodoc/Source/items.h +++ b/util/robodoc/Source/items.h @@ -7,7 +7,8 @@ enum { MAKE_NORMAL = -1, MAKE_LARGE, MAKE_ITALICS, MAKE_NON_PROP, MAKE_SMALL, - MAKE_BOLD, MAKE_UNDERLINE, MAKE_SHINE, MAKE_HIGH, SIZE_ATTRIBUTES + MAKE_BOLD, MAKE_UNDERLINE, MAKE_SHINE, MAKE_HIGH, MAKE_DEFAULT, + SIZE_ATTRIBUTES }; #define ITEM_NAME_LARGE_FONT (1<<0) @@ -19,6 +20,7 @@ enum #define TEXT_BODY_UNDERLINE (1<<(MAKE_UNDERLINE + 1)) #define TEXT_BODY_SHINE (1<<(MAKE_SHINE + 1)) #define TEXT_BODY_HIGHLIGHT (1<<(MAKE_HIGH + 1)) +#define TEXT_BODY_DEFAULT (1<<(MAKE_DEFAULT + 1)) /****** ROBODoc/ItemTypes * -- 2.24.0