Design and Implementation of a Documentation Tool for ... - MADOC

A Implementation of forscript
This section will describe the code of forscript in detail. You will learn how
the software hooks into the input and output stream of the client application and
how it reacts to things like window size changes or the child terminating. Other
interesting topics include how to launch a subprocess and change its controlling
terminal as well as how to read from multiple data streams at once without
having to run separate processes.
A.1 Overview
Here’s the current version number of forscript. Any future alterations can
be explained in the text at relevant placed. MYVERSION is defined as a global
constant.
15a 〈globals 8d〉+≡ (15b) ⊳ 8d 22a ⊲
const char *MYVERSION = "1.0.0";
Defines:
MYVERSION, used in chunk 25b.
The code begins with feature test macros, ordinary macros and include statements.
Afterwards, constants and global variables are defined.
15b 〈declarations and definitions 15b〉≡ (7a)
〈featuretest 27b〉
〈macros 37c〉
〈includes 8b〉
〈constants 16a〉
〈globals 8d〉
The functions used in the code are put in an order that makes sure every
function is defined before it is called. Since die() is required at many places, it
is put first. Next, all the chunk writing functions appear (the helper functions
first). Then come the functions that write startup and shutdown messages on
the screen, followed by the signal handling functions like finish. The functions
doshell and doio are the main input/output functions that represent the parent
and child processes.
15c 〈functions 15c〉≡ (7a)
〈die 23b〉
〈swrite 22b〉
〈chunkw 21〉
〈chunkwhf 22d〉
〈chunkwm 23a〉
〈chunks 17a〉
〈statusmsg 24b〉
〈done 37d〉
〈finish 37b〉
〈winsize 30b〉
〈resized 30a〉
〈doshell 31c〉
〈doio 33c〉
15