C Source Code Conventions and Abbreviations Dictionary

From NARS2000
Revision as of 17:55, 31 July 2015 by Robert Wallick (talk | contribs) (added sample use cols, more abbrev's)
Jump to navigationJump to search

NARS C Source Code Conventions and Abbreviations Dictionary:

Conventions

Convention Syntax Description/Where Used Sample Use Purpose
PrimFn Prefix name prefix to all Primary APL functions PrimFnRho_EM_YY Quickly identify such names
SysFn Prefix name prefix to all Quad type System Functions SysFnWA_EM_YY Quickly identify such names
_EM_YY Suffix name suffix to all Primary APL functions AND Quad System Functions, including monadic and dyadic calls SysFnTS_EM_YY Quickly identify such names, referencing

Abbreviations Dictionary

Abbrev Meaning Location, Use Sample Actual Usage
lp long pointer Usually found as a prefix to variable names. NARS makes frequent use of pointers to speed up processing times, to make NARS2000.exe more efficient. lptkRhtArg (var name; long ptr to token var structure of a right hand argument for a function call)
NELM Nested Element Usually embedded within variable names. APLNELM aplNELMRht; // Right arg NELM for variable type APLNELM and variable named aplNELMRht
PerTab permanent table Embedded in var names. LPPERTABDATA lpMemPTD; where LPPERTABDATA is the variable type and lpMemPTD is a pointer to PerTabData global memory
PTD permanent table of data Embedded in var names. lpMemPTD structured var name, in this case a ptr to PerTabData global memory
SIS State Indicator Stack Frequently embedded within variable and function names. Detailed explanation of SIS found in <sis.h> See also APL's System Command )SI. lpMemPTD->lpSISCur->ResetFlag; (var name) AND FillSISNxt (fcn name)
tk token Frequently found embedded in structured variable names. Tokens are basic building blocks of C Programming; hence tk vars frequently represent important structured variables in NARS. LPTOKEN lptkRhtArg
UTF Unicode Transformation Format Variable names, constants, especially UTF16 UTF16_RHO