Update documentation for nmseffect module

modified:   src/nmseffect.c
This commit is contained in:
Brian Barto 2017-01-20 10:46:33 -05:00
parent 0b44f64468
commit a0d80ddb19

View File

@ -5,6 +5,12 @@
* under the terms of the MIT License. See LICENSE for more details. * under the terms of the MIT License. See LICENSE for more details.
*/ */
/*
* The nmseffect module is the primary module that drives the effect
* execution. Most attributes, settings, and code that define the behavior
* is implemented here.
*/
#define _XOPEN_SOURCE 700 #define _XOPEN_SOURCE 700
#include <stdio.h> #include <stdio.h>
@ -19,12 +25,19 @@
#include "nmstermio.h" #include "nmstermio.h"
#include "nmscharset.h" #include "nmscharset.h"
// Program settings // Speed settings
#define TYPE_EFFECT_SPEED 4 // miliseconds per char #define TYPE_EFFECT_SPEED 4 // miliseconds per char
#define JUMBLE_SECONDS 2 // number of seconds for jumble effect #define JUMBLE_SECONDS 2 // number of seconds for jumble effect
#define JUMBLE_LOOP_SPEED 35 // miliseconds between each jumble #define JUMBLE_LOOP_SPEED 35 // miliseconds between each jumble
#define REVEAL_LOOP_SPEED 50 // miliseconds between each reveal loop #define REVEAL_LOOP_SPEED 50 // miliseconds between each reveal loop
// Behavior settings
static char *returnOpts = NULL; // Return option setting
static int autoDecrypt = 0; // Auto-decrypt flag
static int colorOn = 1; // Terminal color flag
static int inputPositionX = -1; // X coordinate for input position
static int inputPositionY = -1; // Y coordinate for input position
// Character attribute structure, linked list. Keeps track of every // Character attribute structure, linked list. Keeps track of every
// character's attributes required for rendering and decryption effect. // character's attributes required for rendering and decryption effect.
struct charAttr { struct charAttr {
@ -39,13 +52,6 @@ struct charAttr {
// Static function prototypes // Static function prototypes
static void nmseffect_sleep(int); static void nmseffect_sleep(int);
// NMS settings
static char *returnOpts = NULL; // Return option setting
static int autoDecrypt = 0; // Auto-decrypt flag
static int colorOn = 1; // Terminal color flag
static int inputPositionX = -1; // X coordinate for input position
static int inputPositionY = -1; // Y coordinate for input position
/* /*
* This function applies the data decryption effect to the character * This function applies the data decryption effect to the character
* string that is provided as an argument. It returns the last character * string that is provided as an argument. It returns the last character