Futilities/human/lib: Difference between revisions

From Woozle Writes Code
Jump to navigation Jump to search
(Created page with "==Classes== {| class=wikitable ! class name !! purpose |- | cFileInfo || wrapper for <code>stat()</code>/<code>lstat()</code> results |- | cFileSpec || manages construction of...")
 
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Classes==
==Classes==
{| class=wikitable
{| class="wikitable sortable"
! class name !! purpose
! class name !! abs? !! root? !! purpose
|-
|-
| cFileInfo || wrapper for <code>stat()</code>/<code>lstat()</code> results
| {{l/sub|caAppBase}} || Y || Y || Application class
|-
|-
| cFileSpec || manages construction of file-paths while spidering a folder-tree
| {{l/sub|cnFileInfo}} || n || || wrapper for <code>stat()</code>/<code>lstat()</code> results
|-
|-
| cFolderator || iterates a caMatch object through a folder-tree
| {{l/sub|cFileSpec}} || n || || manages construction of file-paths while spidering a folder-tree
|-
|-
| cMatchResult || wraps the result of a string-matching operation
| {{l/sub|cFolderator}} || n || || iterates a caMatch object through a folder-tree
|-
|-
| caMatch || abstract wrapper for determining what constitutes a "match" and what do do when one happens
| {{l/sub|cMatchResult}} || n || || wraps the result of a string-matching operation
|-
| {{l/sub|caMatch}} || Y || Y || Matcher root class. Matchers determine what constitutes a "match" and what do do when one happens
|-
| {{l/sub|caMatchStandard}} || Y || n || Matcher class with some common defaults
|-
| {{l/sub|cPathCap}} || n || n || a caPathNamed where we know the name of the final path-part
|-
| {{l/sub|cPathBlank}} || n || n || a caPathNamed where we don't know the final path-part's name at first; used for directory iteration
|-
| {{l/sub|caPathNamed}} || Y || || a caPathPiece that isn't the path-root
|-
| {{l/sub|caPathPiece}} || Y || Y || class for objectifying filespecs
|-
| {{l/sub|cPathRoot}} || n || n || a caPathPiece that ''is'' the path-root (so no point in giving it a name)
|-
| {{l/sub|csTTY}} || n || || slightly-intelligent static class for handling TTY output
|-
| {{l/sub|cLog}} || n || || log-file operations
|-
| {{l/sub|cOpt}} || n || Y ||  wraps the result of examining a single app option vs. what's in the command-line (basically just a key-value pair)
|-
| {{l/sub|caOptsBase}} || Y || Y || base class for parsing and managing command-line options
|}
|}

Latest revision as of 14:47, 27 September 2022

Classes

class name abs? root? purpose
caAppBase Y Y Application class
cnFileInfo n wrapper for stat()/lstat() results
cFileSpec n manages construction of file-paths while spidering a folder-tree
cFolderator n iterates a caMatch object through a folder-tree
cMatchResult n wraps the result of a string-matching operation
caMatch Y Y Matcher root class. Matchers determine what constitutes a "match" and what do do when one happens
caMatchStandard Y n Matcher class with some common defaults
cPathCap n n a caPathNamed where we know the name of the final path-part
cPathBlank n n a caPathNamed where we don't know the final path-part's name at first; used for directory iteration
caPathNamed Y a caPathPiece that isn't the path-root
caPathPiece Y Y class for objectifying filespecs
cPathRoot n n a caPathPiece that is the path-root (so no point in giving it a name)
csTTY n slightly-intelligent static class for handling TTY output
cLog n log-file operations
cOpt n Y wraps the result of examining a single app option vs. what's in the command-line (basically just a key-value pair)
caOptsBase Y Y base class for parsing and managing command-line options