Worgle

• 1 What is Worgle?
• 2 Top-level files
• 3 An Outline of What Worgle does
• 3.1 Initialization
• 3.1.1 Initialize worgle data
• 3.1.2 Get and set filename
• 3.1.3 Initialize return codes
• 3.1.3.1 Main Return Code
• 3.1.3.2 Line Satus Code
• 3.1.3.3 Mode
• 3.2 Load file into memory
• 3.2.1 Open file
• 3.2.2 Get file size
• 3.2.3 Allocate memory, read, and close
• 3.3 Parsing
• 3.3.1 Parser Local Variables
• 3.3.2 Reading a line at a time
• 3.3.3 Parsing Modes
• 3.3.3.1 MODE_ORG
• 3.3.3.1.1 Extracting information from #+NAME
• 3.3.3.1.2 Beginning a new block
• 3.3.3.2 MODE_BEGINCODE
• 3.3.3.2.1 Extracting information from #+BEGIN_SRC
• 3.3.3.2.2 Setting up code for a new read
• 3.3.3.2.3 Appending a new file
• 3.3.3.3 MODE_CODE
• 3.4 Generation
• 3.5 Cleanup
• 4 Core Data Structures
• 4.1 Top Level Struct
• 4.1.1 Worgle Initialization
• 4.1.2 Worgle Deallocation
• 4.1.3 Worgle Data
• 4.1.3.1 Current Block Name
• 4.1.3.2 Current Line
• 4.1.3.3 Block Started Flag
• 4.1.3.4 Dictionary
• 4.1.3.5 File List
• 4.1.3.6 Text Buffer
• 4.1.3.7 Current Block
• 4.1.3.8 Line Number
• 4.1.3.9 Filename
• 4.2 String
• 4.2.1 Reset or initialize a string
• 4.2.2 Writing a String
• 4.3 Segment
• 4.3.1 Text Chunk Type
• 4.3.2 Reference Type
• 4.3.3 Initializing a Segment
• 4.3.4 Writing a Segment
• 4.4 Code Block
• 4.4.1 Initializing a code block
• 4.4.2 Freeing a code block
• 4.4.3 Appending a segment to a code block
• 4.4.3.1 Appending a string segment
• 4.4.3.2 Appending a reference segment
• 4.4.4 Appending a code block to a code block
• 4.4.5 Writing a code block to filehandle
• 4.5 Code Block List
• 4.5.1 Block List Initialization
• 4.5.2 Freeing a Block List
• 4.5.3 Appending a Block
• 4.6 Hash Map
• 4.6.1 Hash map Initialization
• 4.6.2 Freeing a Hash Map
• 4.6.3 Looking up an entry
• 4.6.4 Getting an entry
• 4.7 File
• 4.7.1 Writing A File to a filehandle
• 4.8 The File List
• 4.8.1 Initializing a file list
• 4.8.2 Freeing a file list
• 4.8.3 Appending a file to a file list
• 4.8.4 Writing a filelist to disk
• 5 Command Line Arguments
• 5.1 Parsing command line flags
• 5.2 Turning on debug macros (-g)
• 5.3 Turning on Warnings (-W)
• 5.3.1 Checking for unused blocks