Coding Convention for Dali VM

C code Naming

• all variables should start with small caps, words are separated by caps. For example : numOfBits
• all global variables should start with prefix "the" for example : theBufferTable
• all function name should start with caps, and words are separated by caps. If a function acts on a data type, it should be preceeded by the name of the data type. For example : MpegSeqHdrParse
• Tcl hooks should end with Cmd postfix, and starts with the same words as the name in the tcl command.  Each tcl function should parse the arguments and then call a C function, which should have the same name as the tcl function without the Cmd postfix. For example :

  
      // byte_scale
  
      int ByteScaleCmd(Tcl_interp *interp, ... ) {
  
  	//parse arguments here
  
  	ByteScale(...);
  
  	return TCL_OK;
  
      }
  
      

  The parameters and return value of the C function should be the same as the tcl command. For example if we have set foo [byte_new $width $height] we should have ByteImage *ByteNew(int width, int height)
• all #defined constant should be all caps, words are separated by underscore. For example : BIT_PARSER_PREFIX
• #defined macros can be either of the following :
  • if it is mimicing a standard C function call, follow the name of that standard C function. (for example: min, max)
  • if it is to be made to look like a function call, or it is use very often, follow the convention of a function. (for example, ReturnErrorIf)
  • otherwise follow the convention of #define constant. (for example, DO_N_TIMES)

Source Code Formating

• indentation should be set to 4
• tab stop should be set to 8
• brackets should be places like this :

	if (...) {

	    x = y;

	} else {

	    x = z;

	}

	while (...) {

	    x = y;

	}

Tcl Command Naming

• all tcl commands name should be small letters, words are separated by underscore. For example, mpeg_seq_hdr_parse.

Last Updated :