Initial conversion from MediaWiki, 20170204

8 files changed, 279 insertions, 0 deletions

diff --git a/module/index.mdwn b/module/index.mdwn
new file mode 100644
index 0000000..63a668a
--- /dev/null
+++ b/module/index.mdwn
@@ -0,0 +1,20 @@
+[[!meta title="Module:Index"]]
+[[!meta author="James Bursa"]]
+[[!meta date="2011-01-09T22:43:50Z"]]
+
+
+[[!toc]]
+
+|colspan=3 style="background: gray; color: white" | NetSurf Code Modules|
+|-----------------------------------------------------------------------|
+|Module|Prefix|Purpose|
+|[[Module:utils/container|module/utils/container]]|container|File format for themes|
+|[[Module:utils/errors|module/utils/errors]]|nserror|Common error codes|
+|[[Module:utils/filename|module/utils/filename]]|filename|Allocation of unique filenames|
+|[[Module:utils/findresource|module/utils/findresource]]|*various*|Finds resource files in a list of locations|
+|[[Module:utils/hashtable|module/utils/hashtable]]|hash|Write-once string to string hash tables|
+|[[Module:utils/http|module/utils/http]]|http|HTTP header parsing|
+|[[Module:utils/locale|module/utils/locale]]|ls|Locale-specific variants of ctype.h functions|
+
+[[!tag module]]
+
diff --git a/module/utils/container.mdwn b/module/utils/container.mdwn
new file mode 100644
index 0000000..5025c2b
--- /dev/null
+++ b/module/utils/container.mdwn
@@ -0,0 +1,38 @@
+[[!meta title="Module:utils/container"]]
+[[!meta author="James Bursa"]]
+[[!meta date="2011-01-09T22:28:35Z"]]
+
+
+[[!toc]] File format for NetSurf
+themes.
+
+:   ''Note: possibly incomplete; no themes currently exist.
+
+Prefix
+------
+
+`container_`
+
+Depends on
+----------
+
+-   [[Module:utils/log|module/utils/log]]
+-   [[Module:utils/messages|module/utils/messages]]
+-   [[Module:utils/utils|module/utils/utils]]
+
+Description
+-----------
+
+This module implements a simple file format which contains a series of
+files (i.e. named chunks of data).
+
+Files
+-----
+
+utils/container.h
+:   Interface
+utils/container.c
+:   Implementation
+
+[[!inline raw=yes pages="Module:Index"]]
+
diff --git a/module/utils/errors.mdwn b/module/utils/errors.mdwn
new file mode 100644
index 0000000..e2b5237
--- /dev/null
+++ b/module/utils/errors.mdwn
@@ -0,0 +1,38 @@
+[[!meta title="Module:utils/errors"]]
+[[!meta author="James Bursa"]]
+[[!meta date="2011-01-09T22:36:17Z"]]
+
+
+[[!toc]] Common error (and OK)
+return codes.
+
+Prefix
+------
+
+`nserror`  
+`NSERROR_`
+
+Depends on
+----------
+
+None.
+
+Description
+-----------
+
+This module defines standard return codes used throughout NetSurf. It
+defines the enum **nserror**.
+
+**NSERROR\_OK** indicates that a function was successful. Other values
+indicate an error as described in utils/error.h.
+
+Files
+-----
+
+utils/error.h
+:   Interface
+
+There is no associated .c file.
+
+[[!inline raw=yes pages="Module:Index"]]
+
diff --git a/module/utils/filename.mdwn b/module/utils/filename.mdwn
new file mode 100644
index 0000000..6c97e46
--- /dev/null
+++ b/module/utils/filename.mdwn
@@ -0,0 +1,38 @@
+[[!meta title="Module:utils/filename"]]
+[[!meta author="James Bursa"]]
+[[!meta date="2011-01-09T22:36:41Z"]]
+
+
+[[!toc]] Central method of
+obtaining unique filenames.
+
+Prefix
+------
+
+`filename_`
+
+Depends on
+----------
+
+-   [[Module:utils/log|module/utils/log]]
+-   [[Module:utils/utils|module/utils/utils]]
+
+Description
+-----------
+
+This module allocates unique filenames in a tree in NetSurf's cache
+directory. Files are arranged in a tree 4 levels deep with up to 64
+files per lowest level directory.
+
+Performance appears to be O(number of files).
+
+Files
+-----
+
+utils/filename.h
+:   Interface
+utils/filename.c
+:   Implementation
+
+[[!inline raw=yes pages="Module:Index"]]
+
diff --git a/module/utils/findresource.mdwn b/module/utils/findresource.mdwn
new file mode 100644
index 0000000..437367c
--- /dev/null
+++ b/module/utils/findresource.mdwn
@@ -0,0 +1,35 @@
+[[!meta title="Module:utils/findresource"]]
+[[!meta author="James Bursa"]]
+[[!meta date="2011-01-09T22:37:11Z"]]
+
+
+[[!toc]] Finds resource files in a
+list of locations.
+
+Prefix
+------
+
+Does not conform to convention; see header.
+
+Depends on
+----------
+
+None.
+
+Description
+-----------
+
+This module supplies functions to find files in a list of directories.
+This is used to load resource files, for example looking in the home
+directory first, and then other standard locations.
+
+Files
+-----
+
+utils/findresources.h
+:   Interface
+utils/findresources.c
+:   Implementation
+
+[[!inline raw=yes pages="Module:Index"]]
+
diff --git a/module/utils/hashtable.mdwn b/module/utils/hashtable.mdwn
new file mode 100644
index 0000000..94b59f9
--- /dev/null
+++ b/module/utils/hashtable.mdwn
@@ -0,0 +1,38 @@
+[[!meta title="Module:utils/hashtable"]]
+[[!meta author="James Bursa"]]
+[[!meta date="2011-01-09T22:37:26Z"]]
+
+
+[[!toc]] Write-once string to
+string hash tables.
+
+Prefix
+------
+
+`hash_`
+
+Depends on
+----------
+
+-   [[Module:utils/log|module/utils/log]]
+
+Description
+-----------
+
+This module implements mappings from string to string using a hash
+table. Pairs can not be removed once added.
+
+The tables have a fixed number of buckets specified on creation, but
+don't grow beyond that. Entries are chained in a linked list in each
+bucket.
+
+Files
+-----
+
+utils/hashtable.h
+:   Interface
+utils/hashtable.c
+:   Implementation
+
+[[!inline raw=yes pages="Module:Index"]]
+
diff --git a/module/utils/http.mdwn b/module/utils/http.mdwn
new file mode 100644
index 0000000..16b8cbc
--- /dev/null
+++ b/module/utils/http.mdwn
@@ -0,0 +1,34 @@
+[[!meta title="Module:utils/http"]]
+[[!meta author="James Bursa"]]
+[[!meta date="2011-01-09T22:37:40Z"]]
+
+
+[[!toc]] HTTP header parsing
+functions.
+
+Prefix
+------
+
+`http_`
+
+Depends on
+----------
+
+-   [[Module:utils/errors|module/utils/errors]]
+
+Description
+-----------
+
+This module contains functions to assist with parsing certain types of
+HTTP headers.
+
+Files
+-----
+
+utils/http.h
+:   Interface
+utils/http.c
+:   Implementation
+
+[[!inline raw=yes pages="Module:Index"]]
+
diff --git a/module/utils/locale.mdwn b/module/utils/locale.mdwn
new file mode 100644
index 0000000..4faa680
--- /dev/null
+++ b/module/utils/locale.mdwn
@@ -0,0 +1,38 @@
+[[!meta title="Module:utils/locale"]]
+[[!meta author="James Bursa"]]
+[[!meta date="2011-01-09T22:42:48Z"]]
+
+
+[[!toc]] Locale-specific variants
+of ctype.h functions.
+
+Prefix
+------
+
+`ls_`
+
+Depends on
+----------
+
+None.
+
+Description
+-----------
+
+This module supplies versions of the character classification functions
+in <ctype.h> that respect the current locale.
+
+NetSurf has a setlocale(LC\_ALL, "C") call in initialization for
+consistent and predictable behaviour. These functions however use the
+environment's locale.
+
+Files
+-----
+
+utils/locale.h
+:   Interface
+utils/locale.c
+:   Implementation
+
+[[!inline raw=yes pages="Module:Index"]]
+