aboutsummaryrefslogtreecommitdiff
path: root/pkg/system/help/helpdir.h
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
committerJoseph Hunkeler <jhunkeler@gmail.com>2015-07-08 20:46:52 -0400
commitfa080de7afc95aa1c19a6e6fc0e0708ced2eadc4 (patch)
treebdda434976bc09c864f2e4fa6f16ba1952b1e555 /pkg/system/help/helpdir.h
downloadiraf-linux-fa080de7afc95aa1c19a6e6fc0e0708ced2eadc4.tar.gz
Initial commit
Diffstat (limited to 'pkg/system/help/helpdir.h')
-rw-r--r--pkg/system/help/helpdir.h34
1 files changed, 34 insertions, 0 deletions
diff --git a/pkg/system/help/helpdir.h b/pkg/system/help/helpdir.h
new file mode 100644
index 00000000..89b851a7
--- /dev/null
+++ b/pkg/system/help/helpdir.h
@@ -0,0 +1,34 @@
+# Size limiting definitions.
+
+define MAX_LDIRS 50 # maximum ldirs for package
+define MAX_MODULES 100 # initial maximum no. modules
+define INC_MODULES 50 # increment if overflow
+define SZ_SBUF 2048 # initial size string buffer
+define INC_SZSBUF 1024 # increment if overflow
+
+define LEN_HDSTRUCT (10+MAX_LDIRS+MAX_MODULES*LEN_MODSTRUCT)
+define LEN_BASEHD 10
+define LEN_MODSTRUCT 6
+
+# Helpdir descriptor structure.
+
+define HD_SBUF Memi[$1] # string buffer
+define HD_NEXTCH Memi[$1+1] # index of next char in sbuf
+define HD_SZSBUF Memi[$1+2] # size of string buffer
+define HD_DEFDIR Memi[$1+3] # offset to defdir
+define HD_NLDIRS Memi[$1+4] # number of logical directories
+define HD_NMODULES Memi[$1+5] # number of modules in package
+define HD_MAXMODULES Memi[$1+6] # max no. of modules in package
+define HD_LENHD Memi[$1+7] # length of this structure
+define HD_PAKNAME Memi[$1+8] # offset of package name string
+define HD_LDIR Memi[$1+10+$2-1] # indices of ldir strings
+define HD_MODULE ($1+60+($2-1)*6) # module descriptors
+
+# Module descriptor structure.
+
+define M_NAME Memi[$1] # module name index
+define M_HLP Memi[$1+1] # help file index
+define M_SYS Memi[$1+2] # system docs file index
+define M_SRC Memi[$1+3] # source code file index
+define M_PKG Memi[$1+4] # pkg helpdir file index
+define M_MEN Memi[$1+5] # package menu file index