1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
4 File : $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
6 Purpose : developer manual
8 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
10 $Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $
12 Written by and Copyright (C) 2001 the SourceForge
13 IJBSWA team. http://ijbswa.sourceforge.net
15 Based on the Internet Junkbuster originally written
16 by and Copyright (C) 1997 Anonymous Coders and
17 Junkbusters Corporation. http://www.junkbusters.com
22 <title>Junkbuster Developer Manual</title>
24 <pubdate>$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $</pubdate>
29 <orgname>By: Junkbuster Developers</orgname>
36 The developer manual gives the users information on how to help the developer
37 team. It provides guidance on coding, testing, documentation and other
38 issues. The Internet Junkbuster is an application
39 that provides privacy and security to the user of the world wide web.
42 You can find the latest version of the user manual at <ulink
43 url="http://ijbswa.sourceforge.net/developer-manual/">http://ijbswa.sourceforge.net/developer-manual/</ulink>.
44 Please see the Contact section in the user-manual if you want to contact the developers.
48 Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
53 <!-- ~~~~~ New section ~~~~~ -->
54 <sect1 id="introduction"><title>Introduction</title>
59 <!-- ~~~~~ New section ~~~~~ -->
60 <sect1 id="quickstart"><title>Quickstart to Junkbuster Development</title>
65 <!-- ~~~~~ New section ~~~~~ -->
66 <sect1 id="documentation"><title>Documentation Guidelines</title>
68 All docs are in SGML format and located in the <computeroutput>doc/source</computeroutput> directory.
71 How do you update the webserver (i.e. the pages on sourceforge)?
72 <OrderedList Numeration="Arabic">
74 Run <computeroutput>make dok</computeroutput> (which uses the documents in <computeroutput>doc/source</computeroutput> to update all
75 text files in <computeroutput>doc/text</computeroutput> and to update
76 all web documents in <computeroutput>doc/webserver</computeroutput>.
79 Run <computeroutput>make webserver</computeroutput> which copies all files from
80 <computeroutput>doc/webserver</computeroutput> to the sourceforge webserver
87 <!-- <ListItem><Para>be consistent with the redirect script (i.e. the junkbuster program -->
88 <!-- points via the redirect URL at sf to valid end-points in the document)</Para></ListItem> -->
90 <!-- ~~~~~ New section ~~~~~ -->
91 <sect1 id="coding"><title>Coding Guidelines</title>
93 <sect2 id="s1"><title>Introduction</title>
95 <para>This set of standards is designed to make our lives easier.
96 It is developed with the simple goal of helping us keep the
97 "new and improved Junkbusters" consistent and reliable. Thus
98 making maintenance easier and increasing chances of success of
101 <para>And that of course comes back to us as individuals. If we
102 can increase our development and product efficiencies then we
103 can solve more of the request for changes/improvements and in
104 general feel good about ourselves. ;-></para>
108 <sect2 id="s2"><title>Using Comments</title>
111 <sect3 id="s3"><title>Comment, Comment, Comment</title>
113 <para><emphasis>Explanation:</></para>
115 <para>Comment as much as possible without commenting the obvious.
116 For example do not comment "aVariable is equal to bVariable".
117 Instead explain why aVariable should be equal to the bVariable.
118 Just because a person can read code does not mean they will
119 understand why or what is being done. A reader may spend a lot
120 more time figuring out what is going on when a simple comment
121 or explanation would have prevented the extra research. Please
122 help your brother IJB'ers out!</para>
124 <para>The comments will also help justify the intent of the code.
125 If the comment describes something different than what the code
126 is doing then maybe a programming error is occurring.</para>
128 <para><emphasis>Example:</></para>
130 /* if page size greater than 1k ... */
131 if ( PageLength() > 1024 )
133 ... "block" the page up ...
136 /* if page size is small, send it in blocks */
137 if ( PageLength() > 1024 )
139 ... "block" the page up ...
142 This demonstrates 2 cases of "what not to do". The first is a
143 "syntax comment". The second is a comment that does not fit what
144 is actually being done.
150 <sect3 id="s4"><title>Use blocks for comments</title>
152 <para><emphasis>Explanation:</></para>
154 <para>Comments can help or they can clutter. They help when they
155 are differentiated from the code they describe. One line
156 comments do not offer effective separation between the comment
157 and the code. Block identifiers do, by surrounding the code
158 with a clear, definable pattern.</para>
160 <para><emphasis>Example:</></para>
162 /*********************************************************************
163 * This will stand out clearly in your code!
164 *********************************************************************/
165 if ( thisVariable == thatVariable )
167 DoSomethingVeryImportant();
171 /* unfortunately, this may not */
172 if ( thisVariable == thatVariable )
174 DoSomethingVeryImportant();
178 if ( thisVariable == thatVariable ) /* this may not either */
180 DoSomethingVeryImportant();
183 <para><emphasis>Exception:</></para>
185 <para>If you are trying to add a small logic comment and do not
186 wish to "disrubt" the flow of the code, feel free to use a 1
187 line comment which is NOT on the same line as the code.</para>
193 <sect3 id="s5"><title>Keep Comments on their own line</title>
195 <para><emphasis>Explanation:</></para>
197 <para>It goes back to the question of readability. If the comment
198 is on the same line as the code it will be harder to read than
199 the comment that is on its own line.</para>
201 <para>There are three exceptions to this rule, which should be
202 violated freely and often: during the definition of variables,
203 at the end of closing braces, when used to comment
206 <para><emphasis>Example:</></para>
208 /*********************************************************************
209 * This will stand out clearly in your code,
210 * But the second example won't.
211 *********************************************************************/
212 if ( thisVariable == thatVariable )
214 DoSomethingVeryImportant();
217 if ( thisVariable == thatVariable ) /*can you see me?*/
219 DoSomethingVeryImportant(); /*not easily*/
223 /*********************************************************************
224 * But, the encouraged exceptions:
225 *********************************************************************/
226 int urls_read = 0; /* # of urls read + rejected */
227 int urls_rejected = 0; /* # of urls rejected */
231 DoSomethingVeryImportant();
235 short DoSomethingVeryImportant(
236 short firstParam, /* represents something */
237 short nextParam /* represents something else */ )
241 } /* -END- DoSomethingVeryImportant */
246 <sect3 id="s6"><title>Comment each logical step</title>
248 <para><emphasis>Explanation:</></para>
250 <para>Logical steps should be commented to help others follow the
251 intent of the written code and comments will make the code more
254 <para>If you have 25 lines of code without a comment, you should
255 probably go back into it to see where you forgot to put
258 <para>Most "for", "while", "do", etc... loops _probably_ need a
259 comment. After all, these are usually major logic
266 <sect3 id="s7"><title>Comment All Functions Thoroughly</title>
268 <para><emphasis>Explanation:</></para>
270 <para>A reader of the code should be able to look at the comments
271 just prior to the beginning of a function and discern the
272 reason for its existence and the consequences of using it. The
273 reader should not have to read through the code to determine if
274 a given function is safe for a desired use. The proper
275 information thoroughly presented at the introduction of a
276 function not only saves time for subsequent maintenance or
277 debugging, it more importantly aids in code reuse by allowing a
278 user to determine the safety and applicability of any function
279 for the problem at hand. As a result of such benefits, all
280 functions should contain the information presented in the
281 addendum section of this document.</para>
287 <sect3 id="s8"><title>Comment at the end of braces if the
288 content is more than one screen length</title>
290 <para><emphasis>Explanation:</></para>
292 <para>Each closing brace should be followed on the same line by a
293 comment that describes the origination of the brace if the
294 original brace is off of the screen, or otherwise far away from
295 the closing brace. This will simplify the debugging,
296 maintenance, and readability of the code.</para>
298 <para>As a suggestion , use the following flags to make the
299 comment and its brace more readable:</para>
301 <para>use following a closing brace: } /* -END- if() or while ()
304 <para><emphasis>Example:</></para>
308 DoSomethingVeryImportant();
309 ...some long list of commands...
310 } /* -END- if x is 1 */
316 DoSomethingVeryImportant();
317 ...some long list of commands...
318 } /* -END- if ( 1 == X ) */
324 <sect2 id="s9"><title>Naming Conventions</title>
328 <sect3 id="s10"><title>Variable Names</title>
330 <para><emphasis>Explanation:</></para>
332 <para>Use all lowercase, and seperate words via an underscore
333 ('_'). Do not start an identifier with an underscore. (ANSI C
334 reserves these for use by the compiler and system headers.) Do
335 not use identifiers which are reserved in ANSI C++. (E.g.
336 template, class, true, false, ...). This is in case we ever
337 decide to port JunkBuster to C++.</para>
339 <para><emphasis>Example:</></para>
341 int ms_iis5_hack = 0;</programlisting>
343 <para><emphasis>Instead of:</></para>
347 int msiis5hack = 0; int msIis5Hack = 0;
355 <sect3 id="s11"><title>Function Names</title>
357 <para><emphasis>Explanation:</></para>
359 <para>Use all lowercase, and seperate words via an underscore
360 ('_'). Do not start an identifier with an underscore. (ANSI C
361 reserves these for use by the compiler and system headers.) Do
362 not use identifiers which are reserved in ANSI C++. (E.g.
363 template, class, true, false, ...). This is in case we ever
364 decide to port JunkBuster to C++.</para>
366 <para><emphasis>Example:</></para>
368 int load_some_file( struct client_state *csp )</programlisting>
370 <para><emphasis>Instead of:</></para>
374 int loadsomefile( struct client_state *csp )
375 int loadSomeFile( struct client_state *csp )
383 <sect3 id="s12"><title>Header file prototypes</title>
385 <para><emphasis>Explanation:</></para>
387 <para>Use a descriptive parameter name in the function prototype
388 in header files. Use the same parameter name in the header file
389 that you use in the c file.</para>
391 <para><emphasis>Example:</></para>
393 (.h) extern int load_aclfile( struct client_state *csp );
394 (.c) int load_aclfile( struct client_state *csp )</programlisting>
396 <para><emphasis>Instead of:</>
398 (.h) extern int load_aclfile( struct client_state * ); or
399 (.h) extern int load_aclfile();
400 (.c) int load_aclfile( struct client_state *csp )
408 <sect3 id="s13"><title>Enumerations, and #defines</title>
410 <para><emphasis>Explanation:</></para>
412 <para>Use all capital letters, with underscores between words. Do
413 not start an identifier with an underscore. (ANSI C reserves
414 these for use by the compiler and system headers.)</para>
416 <para><emphasis>Example:</></para>
418 (enumeration) : enum Boolean { FALSE, TRUE };
419 (#define) : #define DEFAULT_SIZE 100;</programlisting>
421 <para><emphasis>Note:</> We have a standard naming scheme for #defines
422 that toggle a feature in the preprocessor: FEATURE_>, where
423 > is a short (preferably 1 or 2 word) description.</para>
425 <para><emphasis>Example:</></para>
427 #define FEATURE_FORCE 1
430 #define FORCE_PREFIX blah
431 #endif /* def FEATURE_FORCE */
436 <sect3 id="s14"><title>Constants</title>
438 <para><emphasis>Explanation:</></para>
440 <para>Spell common words out entirely (do not remove vowels).</para>
442 <para>Use only widely-known domain acronyms and abbreviations.
443 Capitalize all letters of an acronym.</para>
445 <para>Use underscore (_) to separate adjacent acronyms and
446 abbreviations. Never terminate a name with an underscore.</para>
448 <para><emphasis>Example:</></para>
450 #define USE_IMAGE_LIST 1</programlisting>
452 <para><emphasis>Instead of:</></para>
456 #define USE_IMG_LST 1 or
457 #define _USE_IMAGE_LIST 1 or
458 #define USE_IMAGE_LIST_ 1 or
459 #define use_image_list 1 or
460 #define UseImageList 1
470 <sect2 id="s15"><title>Using Space</title>
474 <sect3 id="s16"><title>Put braces on a line by themselves.</title>
476 <para><emphasis>Explanation:</></para>
478 <para>The brace needs to be on a line all by itself, not at the
479 end of the statement. Curly braces should line up with the
480 construct that they're associated with. This practice makes it
481 easier to identify the opening and closing braces for a
484 <para><emphasis>Example:</></para>
491 <para><emphasis>Instead of:</></para>
493 <para>if ( this == that ) { ... }</para>
497 <para>if ( this == that ) { ... }</para>
499 <para><emphasis>Note:</> In the special case that the if-statement is
500 inside a loop, and it is trivial, i.e. it tests for a
501 condidtion that is obvious from the purpose of the block,
502 one-liners as above may optically preserve the loop structure
503 and make it easier to read.</para>
505 <para><emphasis>Status:</> developer-discrection.</para>
507 <para><emphasis>Example exception:</></para>
509 while ( more lines are read )
511 /* Please document what is/is not a comment line here */
512 if ( it's a comment ) continue;
514 do_something( line );
520 <sect3 id="s17"><title>ALL control statements should have a
523 <para><emphasis>Explanation:</></para>
525 <para>Using braces to make a block will make your code more
526 readable and less prone to error. All control statements should
527 have a block defined.</para>
529 <para><emphasis>Example:</></para>
537 <para><emphasis>Instead of:</></para>
539 <para>if ( this == that ) DoSomething(); DoSomethingElse();</para>
543 <para>if ( this == that ) DoSomething();</para>
545 <para><emphasis>Note:</> The first example in "Instead of" will execute
546 in a manner other than that which the developer desired (per
547 indentation). Using code braces would have prevented this
548 "feature". The "explanation" and "exception" from the point
549 above also applies.</para>
555 <sect3 id="s18"><title>Do not belabor/blow-up boolean
558 <para><emphasis>Example:</></para>
560 structure->flag = ( condition );</programlisting>
562 <para><emphasis>Instead of:</></para>
564 <para>if ( condition ) { structure->flag = 1; } else {
565 structure->flag = 0; }</para>
567 <para><emphasis>Note:</> The former is readable and consice. The later
568 is wordy and inefficient. Please assume that any developer new
569 to the project has at least a "good" knowledge of C/C++. (Hope
570 I do not offend by that last comment ... 8-)</para>
576 <sect3 id="s19"><title>Use white space freely because it is
579 <para><emphasis>Explanation:</></para>
581 <para>Make it readable. The notable exception to using white space
582 freely is listed in the next guideline.</para>
584 <para><emphasis>Example:</></para>
588 int anotherValue = 0;
589 int thisVariable = 0;
591 if ( thisVariable == thatVariable )
593 firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
598 <sect3 id="s20"><title>Don't use white space around structure
601 <para><emphasis>Explanation:</></para>
603 <para>- structure pointer operator ( "->" ) - member operator (
604 "." ) - functions and parentheses</para>
606 <para>It is a general coding practice to put pointers, references,
607 and function parentheses next to names. With spaces, the
608 connection between the object and variable/function name is not
611 <para><emphasis>Example:</></para>
615 FunctionName();</programlisting>
617 <para><emphasis>Instead of:</> aStruct -> aMember; aStruct . aMember;
618 FunctionName ();</para>
624 <sect3 id="s21"><title>Make the last brace of a function stand
627 <para><emphasis>Example:</></para>
634 } /* -END- function1 */
639 } /* -END- function2 */
642 <para><emphasis>Instead of:</></para>
644 <para>int function1( ... ) { ...code... return( retCode ); } int
645 function2( ... ) { }</para>
647 <para><emphasis>Note:</> Use 1 blank line before the closing brace and 2
648 lines afterwards. This makes the end of function standout to
649 the most casual viewer. Although function comments help
650 seperate functions, this is still a good coding practice. In
651 fact, I follow these rules when using blocks in "for", "while",
652 "do" loops, and long if {} statements too. After all whitespace
655 <para><emphasis>Status:</> developer-discrection on the number of blank
656 lines. Enforced is the end of function comments.</para>
662 <sect3 id="s22"><title>Use 3 character indentions</title>
664 <para><emphasis>Explanation:</></para>
666 <para>If some use 8 character TABs and some use 3 character TABs,
667 the code can look *very* ragged. So use 3 character indentions
668 only. If you like to use TABs, pass your code through a filter
669 such as "expand -t3" before checking in your code.</para>
671 <para><emphasis>Example:</></para>
673 static const char * const url_code_map[256] =
683 return( ALWAYS_TRUE );
687 return( HOW_DID_YOU_GET_HERE );
690 return( NEVER_GETS_HERE );
699 <sect2 id="s23"><title>Initializing</title>
703 <sect3 id="s24"><title>Initialize all variables</title>
705 <para><emphasis>Explanation:</></para>
707 <para>Do not assume that the variables declared will not be used
708 until after they have been assigned a value somewhere else in
709 the code. Remove the chance of accidentally using an unassigned
712 <para><emphasis>Example:</></para>
716 struct *ptr = NULL;</programlisting>
718 <para><emphasis>Note:</> It is much easier to debug a SIGSEGV if the
719 message says you are trying to access memory address 00000000
720 and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
723 <para><emphasis>Status:</> developer-discrection if and only if the
724 variable is assigned a value "shortly after" declaration.</para>
730 <sect2 id="s25"><title>Functions</title>
734 <sect3 id="s26"><title>Name functions that return a boolean as a
737 <para><emphasis>Explanation:</></para>
739 <para>Value should be phrased as a question that would logically
740 be answered as a true or false statement</para>
742 <para><emphasis>Example:</></para>
751 <sect3 id="s27"><title>Always specify a return type for a
754 <para><emphasis>Explanation:</></para>
756 <para>The default return for a function is an int. To avoid
757 ambiguity, create a return for a function when the return has a
758 purpose, and create a void return type if the function does not
759 need to return anything.</para>
765 <sect3 id="s28"><title>Minimize function calls when iterating by
766 using variables</title>
768 <para><emphasis>Explanation:</></para>
770 <para>It is easy to write the following code, and a clear argument
771 can be made that the code is easy to understand:</para>
773 <para><emphasis>Example:</></para>
775 for ( size_t cnt = 0; cnt < blockListLength(); cnt ++ )
780 <para><emphasis>Note:</> Unfortunately, this makes a function call for
781 each and every iteration. This increases the overhead in the
782 program, because the compiler has to look up the function each
783 time, call it, and return a value. Depending on what occurs in
784 the blockListLength() call, it might even be creating and
785 destroying structures with each iteration, even though in each
786 case it is comparing "cnt" to the same value, over and over.
787 Remember too - even a call to blockListLength() is a function
788 call, with the same overhead.</para>
790 <para>Instead of using a function call during the iterations,
791 assign the value to a variable, and evaluate using the
794 <para><emphasis>Example:</></para>
796 size_t len = blockListLength();
798 for ( size_t cnt = 0; cnt < len; cnt ++ )
803 <para><emphasis>Exceptions:</> if the value of blockListLength() *may*
804 change or could *potentially* change, then you must code the
805 function call in the for/while loop.</para>
811 <sect3 id="s29"><title>Pass and Return by Const Reference</title>
813 <para><emphasis>Explanation:</></para>
815 <para>This allows a developer to define a const pointer and call
816 your function. If your function does not have the const
817 keyword, we may not be able to use your function. Consider
818 strcmp, if it were defined as: extern int strcmp( char *s1,
821 <para>I could then not use it to compare argv's in main: int main(
822 int argc, const char *argv[] ) { strcmp( argv[0], "junkbusters"
825 <para>Both these pointers are *const*! If the c runtime library
826 maintainers do it, we should too.</para>
832 <sect3 id="s30"><title>Pass and Return by Value</title>
834 <para><emphasis>Explanation:</></para>
836 <para>Most structures cannot fit onto a normal stack entry (i.e.
837 they are not 4 bytes or less). Aka, a function declaration
838 like: int load_aclfile( struct client_state csp )</para>
840 <para>would not work. So, to be consistent, we should declare all
841 prototypes with "pass by value": int load_aclfile( struct
842 client_state *csp )</para>
848 <sect3 id="s31"><title>Names of include files</title>
850 <para><emphasis>Explanation:</></para>
852 <para>Your include statements should contain the file name without
853 a path. The path should be listed in the Makefile, using -I as
854 processor directive to search the indicated paths. An exception
855 to this would be for some proprietary software that utilizes a
856 partial path to distinguish their header files from system or
857 other header files.</para>
859 <para><emphasis>Example:</></para>
861 #include <iostream.h> /* This is not a local include */
862 #include "config.h" /* This IS a local include */
865 <para><emphasis>Exception:</></para>
869 /* This is not a local include, but requires a path element. */
870 #include <sys/fileName.h>
874 <para><emphasis>Note:</> Please! do not add "-I." to the Makefile
875 without a _very_ good reason. This duplicates the #include
876 "file.h" behaviour.</para>
882 <sect3 id="s32"><title>Provide multiple inclusion
885 <para><emphasis>Explanation:</></para>
887 <para>Prevents compiler and linker errors resulting from
888 redefinition of items.</para>
890 <para>Wrap each header file with the following syntax to prevent
891 multiple inclusions of the file. Of course, replace PROJECT_H
892 with your file name, with "." Changed to "_", and make it
895 <para><emphasis>Example:</></para>
897 #ifndef PROJECT_H_INCLUDED
898 #define PROJECT_H_INCLUDED
900 #endif /* ndef PROJECT_H_INCLUDED */
905 <sect3 id="s33"><title>Use `extern "C"` when appropriate</title>
907 <para><emphasis>Explanation:</></para>
909 <para>If our headers are included from C++, they must declare our
910 functions as `extern "C"`. This has no cost in C, but increases
911 the potential re-usability of our code.</para>
913 <para><emphasis>Example:</></para>
918 #endif /* def __cplusplus */
920 ... function definitions here ...
924 #endif /* def __cplusplus */
929 <sect3 id="s34"><title>Where Possible, Use Forward Struct
930 Declaration Instead of Includes</title>
932 <para><emphasis>Explanation:</></para>
934 <para>Useful in headers that include pointers to other struct's.
935 Modifications to excess header files may cause needless
938 <para><emphasis>Example:</></para>
940 /*********************************************************************
941 * We're avoiding an include statement here!
942 *********************************************************************/
944 extern file_list *xyz;</programlisting>
946 <para><emphasis>Note:</> If you declare "file_list xyz;" (without the
947 pointer), then including the proper header file is necessary.
948 If you only want to prototype a pointer, however, the header
949 file is unneccessary.</para>
951 <para><emphasis>Status:</> Use with discrection.</para>
957 <sect2 id="s35"><title>General Coding Practices</title>
961 <sect3 id="s36"><title>Turn on warnings</title>
963 <para><emphasis>Explanation</></para>
965 <para>Compiler warnings are meant to help you find bugs. You
966 should turn on as many as possible. With GCC, the switch is
967 "-Wall". Try and fix as many warnings as possible.</para>
973 <sect3 id="s37"><title>Provide a default case for all switch
976 <para><emphasis>Explanation:</></para>
978 <para>What you think is guaranteed is never really guaranteed. The
979 value that you don't think you need to check is the one that
980 someday will be passed. So, to protect yourself from the
981 unknown, always have a default step in a switch statement.</para>
983 <para><emphasis>Example:</></para>
985 switch( hash_string( cmd ) )
987 case hash_actions_file :
997 ... anomly code goes here ...
998 continue; / break; / exit( 1 ); / etc ...
1000 } /* end switch( hash_string( cmd ) ) */</programlisting>
1002 <para><emphasis>Note:</> If you already have a default condition, you
1003 are obviously exempt from this point. Of note, most of the
1004 WIN32 code calls `DefWindowProc' after the switch statement.
1005 This API call *should* be included in a default statement.</para>
1007 <para><emphasis>Another Note:</> This is not so much a readability issue
1008 as a robust programming issue. The "anomly code goes here" may
1009 be no more than a print to the STDERR stream (as in
1010 load_config). Or it may really be an ABEND condition.</para>
1012 <para><emphasis>Status:</> Programmer discretion is advised.</para>
1018 <sect3 id="s38"><title>Try to avoid falling through cases in a
1019 switch statement.</title>
1021 <para><emphasis>Explanation:</></para>
1023 <para>In general, you will want to have a 'break' statement within
1024 each 'case' of a switch statement. This allows for the code to
1025 be more readable and understandable, and furthermore can
1026 prevent unwanted surprises if someone else later gets creative
1027 and moves the code around.</para>
1029 <para>The language allows you to plan the fall through from one
1030 case statement to another simply by omitting the break
1031 statement within the case statement. This feature does have
1032 benefits, but should only be used in rare cases. In general,
1033 use a break statement for each case statement.</para>
1035 <para>If you choose to allow fall through, you should comment both
1036 the fact of the fall through and reason why you felt it was
1043 <sect3 id="s39"><title>Use 'long' or 'short' Instead of
1046 <para><emphasis>Explanation:</></para>
1048 <para>On 32-bit platforms, int usually has the range of long. On
1049 16-bit platforms, int has the range of short.</para>
1051 <para><emphasis>Status:</> open-to-debate. In the case of most FSF
1052 projects (including X/GNU-Emacs), there are typedefs to int4,
1053 int8, int16, (or equivalence ... I forget the exact typedefs
1054 now). Should we add these to IJB now that we have a "configure"
1061 <sect3 id="s40"><title>Don't mix size_t and other types</title>
1063 <para><emphasis>Explanation:</></para>
1065 <para>The type of size_t varies across platforms. Do not make
1066 assumptions about whether it is signed or unsigned, or about
1067 how long it is. Do not compare a size_t against another
1068 variable of a different type (or even against a constant)
1069 without casting one of the values. Try to avoid using size_t if
1076 <sect3 id="s41"><title>Declare each variable and struct on its
1079 <para><emphasis>Explanation:</></para>
1081 <para>It can be tempting to declare a series of variables all on
1082 one line. Don't.</para>
1084 <para><emphasis>Example:</></para>
1088 long c = 0;</programlisting>
1090 <para><emphasis>Instead of:</></para>
1092 <para>long a, b, c;</para>
1094 <para><emphasis>Explanation:</> - there is more room for comments on the
1095 individual variables - easier to add new variables without
1096 messing up the original ones - when searching on a variable to
1097 find its type, there is less clutter to "visually"
1100 <para><emphasis>Exceptions:</> when you want to declare a bunch of loop
1101 variables or other trivial variables; feel free to declare them
1102 on 1 line. You should, although, provide a good comment on
1103 their functions.</para>
1105 <para><emphasis>Status:</> developer-discrection.</para>
1111 <sect3 id="s42"><title>Use malloc/zalloc sparingly</title>
1113 <para><emphasis>Explanation:</></para>
1115 <para>Create a local stuct (on the stack) if the variable will
1116 live and die within the context of one function call.</para>
1118 <para>Only "malloc" a struct (on the heap) if the variable's life
1119 will extend beyond the context of one function call.</para>
1121 <para><emphasis>Example:</></para>
1123 If a function creates a struct and stores a pointer to it in a
1124 list, then it should definately be allocated via `malloc'.
1129 <sect3 id="s43"><title>The Programmer Who Uses 'malloc' is
1130 Responsible for Ensuring 'free'</title>
1132 <para><emphasis>Explanation:</></para>
1134 <para>If you have to "malloc" an instance, you are responsible for
1135 insuring that the instance is `free'd, even if the deallocation
1136 event falls within some other programmer's code. You are also
1137 responsible for ensuring that deletion is timely (i.e. not too
1138 soon, not too late). This is known as "low-coupling" and is a
1139 "good thing (tm)". You may need to offer a
1140 free/unload/destuctor type function to accomodate this.</para>
1142 <para><emphasis>Example:</></para>
1144 int load_re_filterfile( struct client_state *csp ) { ... }
1145 static void unload_re_filterfile( void *f ) { ... }</programlisting>
1147 <para><emphasis>Exceptions:</></para>
1149 <para>The developer cannot be expected to provide `free'ing
1150 functions for C run-time library functions ... such as
1153 <para><emphasis>Status:</> developer-discrection. The "main" use of this
1154 standard is for allocating and freeing data structures (complex
1161 <sect3 id="s44"><title>Add loaders to the `file_list' structure
1162 and in order</title>
1164 <para><emphasis>Explanation:</></para>
1166 <para>I have ordered all of the "blocker" file code to be in alpha
1167 order. It is easier to add/read new blockers when you expect a
1168 certain order.</para>
1170 <para><emphasis>Note:</> It may appear that the alpha order is broken in
1171 places by POPUP tests coming before PCRS tests. But since
1172 POPUPs can also be referred to as KILLPOPUPs, it is clear that
1173 it should come first.</para>
1179 <sect3 id="s45"><title>"Uncertain" new code and/or changes to
1180 exitinst code, use FIXME</title>
1182 <para><emphasis>Explanation:</></para>
1184 <para>If you have enough confidence in new code or confidence in
1185 your changes, but are not *quite* sure of the reprocussions,
1188 <para>/* FIXME: this code has a logic error on platform XYZ, *
1189 attempthing to fix */ #ifdef PLATFORM ...changed code here...
1194 <para>/* FIXME: I think the original author really meant this...
1195 */ ...changed code here...</para>
1199 <para>/* FIXME: new code that *may* break something else... */
1200 ...new code here...</para>
1202 <para><emphasis>Note:</> If you make it clear that this may or may not
1203 be a "good thing (tm)", it will be easier to identify and
1204 include in the project (or conversly exclude from the
1212 <sect2 id="s46"><title>Addendum: Template for files and function
1213 comment blocks:</title>
1215 <para><emphasis>Example for file comments:</></para>
1217 const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $";
1218 /*********************************************************************
1220 * File : $S<!-- Break CVS Substitution -->ource$
1222 * Purpose : (Fill me in with a good description!)
1224 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1225 * IJBSWA team. http://ijbswa.sourceforge.net
1227 * Based on the Internet Junkbuster originally written
1228 * by and Copyright (C) 1997 Anonymous Coders and
1229 * Junkbusters Corporation. http://www.junkbusters.com
1231 * This program is free software; you can redistribute it
1232 * and/or modify it under the terms of the GNU General
1233 * Public License as published by the Free Software
1234 * Foundation; either version 2 of the License, or (at
1235 * your option) any later version.
1237 * This program is distributed in the hope that it will
1238 * be useful, but WITHOUT ANY WARRANTY; without even the
1239 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1240 * PARTICULAR PURPOSE. See the GNU General Public
1241 * License for more details.
1243 * The GNU General Public License should be included with
1244 * this file. If not, you can view it at
1245 * http://www.gnu.org/copyleft/gpl.html
1246 * or write to the Free Software Foundation, Inc., 59
1247 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1250 * $L<!-- Break CVS Substitution -->og$
1252 *********************************************************************/
1257 ...necessary include files for us to do our work...
1259 const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
1262 <para><emphasis>Note:</> This declares the rcs variables that should be
1263 added to the "show-proxy-args" page. If this is a brand new
1264 creation by you, you are free to change the "Copyright" section
1265 to represent the rights you wish to maintain.</para>
1267 <para><emphasis>Note:</> The formfeed character that is present right
1268 after the comment flower box is handy for (X|GNU)Emacs users to
1269 skip the verbige and get to the heart of the code (via
1270 `forward-page' and `backward-page'). Please include it if you
1273 <para><emphasis>Example for file header comments:</></para>
1277 #define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.4 2001/09/23 10:13:48 swa Exp $"
1278 /*********************************************************************
1280 * File : $S<!-- Break CVS Substitution -->ource$
1282 * Purpose : (Fill me in with a good description!)
1284 * Copyright : Written by and Copyright (C) 2001 the SourceForge
1285 * IJBSWA team. http://ijbswa.sourceforge.net
1287 * Based on the Internet Junkbuster originally written
1288 * by and Copyright (C) 1997 Anonymous Coders and
1289 * Junkbusters Corporation. http://www.junkbusters.com
1291 * This program is free software; you can redistribute it
1292 * and/or modify it under the terms of the GNU General
1293 * Public License as published by the Free Software
1294 * Foundation; either version 2 of the License, or (at
1295 * your option) any later version.
1297 * This program is distributed in the hope that it will
1298 * be useful, but WITHOUT ANY WARRANTY; without even the
1299 * implied warranty of MERCHANTABILITY or FITNESS FOR A
1300 * PARTICULAR PURPOSE. See the GNU General Public
1301 * License for more details.
1303 * The GNU General Public License should be included with
1304 * this file. If not, you can view it at
1305 * http://www.gnu.org/copyleft/gpl.html
1306 * or write to the Free Software Foundation, Inc., 59
1307 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1310 * $L<!-- Break CVS Substitution -->og$
1312 *********************************************************************/
1315 #include "project.h"
1321 ... function headers here ...
1324 /* Revision control strings from this header and associated .c file */
1325 extern const char FILENAME_rcs[];
1326 extern const char FILENAME_h_rcs[];
1333 #endif /* ndef _FILENAME_H */
1342 <para><emphasis>Example for function comments:</></para>
1344 /*********************************************************************
1346 * Function : FUNCTION_NAME
1348 * Description : (Fill me in with a good description!)
1351 * 1 : param1 = pointer to an important thing
1352 * 2 : x = pointer to something else
1354 * Returns : 0 => Ok, everything else is an error.
1356 *********************************************************************/
1357 int FUNCTION_NAME( void *param1, const char *x )
1365 <para><emphasis>Note:</> If we all follow this practice, we should be
1366 able to parse our code to create a "self-documenting" web
1373 <!-- ~~~~~ New section ~~~~~ -->
1374 <sect1 id="cvs"><title>Version Control Guidelines</title>
1375 <para>To be filled. note on cvs comments. don't comment what you did, comment
1380 <!-- ~~~~~ New section ~~~~~ -->
1381 <sect1 id="testing"><title>Testing Guidelines</title>
1385 <!-- ~~~~~ New section ~~~~~ -->
1386 <sect2 id="testing-plan"><title>Testplan for releases</title>
1388 Explain release numbers. major, minor. developer releases. etc.
1390 <OrderedList Numeration="Arabic">
1392 Remove any existing rpm with rpm -e
1395 Remove any file that was left over. This includes (but is not limited to)
1397 <ListItem><Para>/var/log/junkbuster</Para></ListItem>
1398 <ListItem><Para>/etc/junkbuster</Para></ListItem>
1399 <ListItem><Para>/usr/sbin/junkbuster</Para></ListItem>
1400 <ListItem><Para>/etc/init.d/junkbuster</Para></ListItem>
1401 <ListItem><Para>/usr/doc/junkbuster*</Para></ListItem>
1405 Install the rpm. Any error messages?
1407 <ListItem><Para>start,stop,status junkbuster with the specific script
1408 (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does
1409 autostart work?</Para></ListItem>
1410 <ListItem><Para>Start browsing. Does the junkbuster work? Logfile written?</Para></ListItem>
1411 <ListItem><Para>Remove the rpm. Any error messages? All files removed?</Para></ListItem>
1416 <!-- ~~~~~ New section ~~~~~ -->
1417 <sect2 id="testing-report"><title>Test reports</title>
1419 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
1420 at sourceforge. Three simple steps:
1423 <ListItem><Para>Select category: the distribution you test on.</Para></ListItem>
1424 <ListItem><Para>Select group: the version of Junkbuster that we are about to release.</Para></ListItem>
1425 <ListItem><Para>Fill the Summary and Detailed Description with something
1426 intelligent (keep it short and precise).</Para>
1429 Do not mail to the mailinglist (we cannot keep track on issues there).
1435 <!-- ~~~~~ New section ~~~~~ -->
1436 <sect1 id="contact"><title>Contact the developers</title>
1437 <para>Please see the user manual for information on how to contact the developers.
1441 <!-- ~~~~~ New section ~~~~~ -->
1442 <sect1 id="copyright"><title>Copyright and History</title>
1443 <para>Please see the user manual for information on Copyright and History.
1447 <!-- ~~~~~ New section ~~~~~ -->
1448 <sect1 id="seealso"><title>See also</title>
1449 <para>Please see the user manual for information on references.
1455 This program is free software; you can redistribute it
1456 and/or modify it under the terms of the GNU General
1457 Public License as published by the Free Software
1458 Foundation; either version 2 of the License, or (at
1459 your option) any later version.
1461 This program is distributed in the hope that it will
1462 be useful, but WITHOUT ANY WARRANTY; without even the
1463 implied warranty of MERCHANTABILITY or FITNESS FOR A
1464 PARTICULAR PURPOSE. See the GNU General Public
1465 License for more details.
1467 The GNU General Public License should be included with
1468 this file. If not, you can view it at
1469 http://www.gnu.org/copyleft/gpl.html
1470 or write to the Free Software Foundation, Inc., 59
1471 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
1473 $Log: developer-manual.sgml,v $
1474 Revision 1.4 2001/09/23 10:13:48 swa
1475 upload process established. run make webserver and
1476 the documentation is moved to the webserver. documents
1477 are now linked correctly.
1479 Revision 1.3 2001/09/13 15:27:40 swa
1482 Revision 1.2 2001/09/13 15:20:17 swa
1483 merged standards into developer manual
1485 Revision 1.1 2001/09/12 15:36:41 swa
1486 source files for junkbuster documentation
1488 Revision 1.3 2001/09/10 17:43:59 swa
1489 first proposal of a structure.
1491 Revision 1.2 2001/06/13 14:28:31 swa
1492 docs should have an author.
1494 Revision 1.1 2001/06/13 14:20:37 swa
1495 first import of project's documentation for the webserver.