utilities.h

Go to the documentation of this file.

#ifndef UTILITIES_H
#define UTILITIES_H

#include <cstdlib>
#include <ctime>
#include <string>
#include <vector>
using std::cout;
using std::string;
using std::vector;

namespace Scobey
{

//************************************************************************
//Typedef Section

typedef char String80[81];
//
//
//************************************************************************
//Named Constant Section

const string CARD_DECK[] =
    { "AS", "2S", "3S", "4S", "5S", "6S", "7S",
      "8S", "9S", "TS", "JS", "QS", "KS",
      "AH", "2H", "3H", "4H", "5H", "6H", "7H",
      "8H", "9H", "TH", "JH", "QH", "KH",
      "AD", "2D", "3D", "4D", "5D", "6D", "7D",
      "8D", "9D", "TD", "JD", "QD", "KD",
      "AC", "2C", "3C", "4C", "5C", "6C", "7C",
      "8C", "9C", "TC", "JC", "QC", "KC"
    };
const string DAYS_OF_THE_WEEK_LONG[] =
    { "Monday", "Tuesday",  "Wednesday", "Thursday",
      "Friday", "Saturday", "Sunday"
    };
const string DAYS_OF_THE_WEEK_SHORT[] =
    { "Mon", "Tue",  "Wed", "Thu",
      "Fri", "Sat", "Sun"
    };
const string DEFAULT_PROGRAM_INFO =
    "Descriptive text required here is specificed elsewhere.";
const string DEFAULT_PROGRAMMER_INFO =
    "Lastname:Firstname:A00123456:CSC?????";
const string MONTHS_OF_THE_YEAR_LONG[] =
    { "January",   "February", "March",    "April",
      "May",       "June",     "July",     "August",
      "September", "October",  "November", "December"
    };
const string MONTHS_OF_THE_YEAR_SHORT[] =
    { "Jan", "Feb", "Mar", "Apr", "May", "Jun",
      "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
    };
const string NAMES_3CHAR[] =
    { "Ace", "Ali", "Amy", "Ann", "Art",
      "Ben", "Bob", "Cal", "Dan", "Del",
      "Don", "Dot", "Eva", "Eve", "Fay",
      "Gil", "Guy", "Hal", "Ian", "Jan",
      "Jim", "Jon", "Kay", "Ken", "Kim",
      "Liz", "Mac", "Min", "Nan", "Ora",
      "Pam", "Red", "Rex", "Rik", "Rip",
      "Rob", "Rod", "Rog", "Ron", "Roy",
      "Sal", "Sam", "Sue", "Tad", "Tim",
      "Tom", "Uma", "Val", "Wes", "Zig"
    };
const string NAMES_FAMILY[] =
    { "Smith", "Johnson", "Williams", "Brown", "Jones",
      "Miller", "Davis", "Garcia", "Rodriguez", "Wilson",
      "Martinez", "Anderson", "Taylor", "Thomas", "Hernandez",
      "Moore", "Martin", "Jackson", "Thompson", "White",
      "Lopez", "Le", "Gonzalez", "Harris", "Clark",
      "Lewis", "Robinson", "Walker", "Perez", "Hall",
      "Young", "Allen", "Sanchez", "Wright", "King",
      "Scott", "Green", "Baker", "Adams", "Nelson",
      "Hill", "Ramirez", "Campbell", "Mitchell", "Roberts",
      "Carter", "Phillips", "Evans", "Turner", "Torres",
      "Parker", "Collins", "Edwards", "Stewart", "Flores",
      "Morris", "Nguyen", "Murphy", "Rivera", "Cook",
      "Rogers", "Morgan", "Peterson", "Cooper", "Reed",
      "Bailey", "Bell", "Gomez", "Kelly", "Howard",
      "Ward", "Cox", "Diaz", "Richardson", "Wood",
      "Watson", "Brooks", "Bennett", "Gray", "James",
      "Reyes", "Cruz", "Hughes", "Price", "Myers",
      "Long", "Foster", "Sanders", "Ross", "Morales",
      "Powell", "Sullivan", "Russell", "Ortiz", "Jenkins",
      "Gutierrez", "Perry", "Butler", "Barnes", "Fisher"
    };
const string NAMES_FEMALE[] =
    { "Mary", "Patricia", "Linda", "Barbara", "Elizabeth", "Jennifer",
      "Maria", "Susan", "Margaret", "Dorothy", "Lisa", "Nancy",
      "Karen", "Betty", "Helen", "Sandra", "Donna", "Carol",
      "Ruth", "Sharon", "Michelle", "Laura", "Sarah", "Kimberly",
      "Deborah", "Jessica", "Shirley", "Cynthia", "Angela", "Melissa",
      "Brenda", "Amy", "Anna", "Rebecca", "Virginia", "Kathleen",
      "Pamela", "Martha", "Debra", "Amanda", "Stephanie", "Carolyn",
      "Christine", "Marie", "Janet", "Catherine", "Frances", "Ann",
      "Joyce", "Diane", "Alice", "Julie", "Heather", "Teresa",
      "Doris", "Gloria", "Evelyn", "Jean", "Cheryl", "Mildred",
      "Katherine", "Joan", "Ashley", "Judith", "Rose", "Janice",
      "Kelly", "Nicole", "Judy", "Christina", "Kathy", "Theresa",
      "Beverly", "Denise", "Tammy", "Irene", "Jane", "Lori",
      "Rachel", "Marilyn", "Andrea", "Kathryn", "Louise", "Sara",
      "Anne", "Jacqueline", "Wanda", "Bonnie", "Julia", "Ruby",
      "Lois", "Tina", "Phyllis", "Norma", "Paula", "Diana",
      "Annie", "Lillian", "Emily", "Robin", "Peggy", "Crystal",
      "Gladys", "Rita", "Dawn", "Connie", "Florence", "Tracy",
      "Edna", "Tiffany", "Carmen", "Rosa", "Cindy", "Grace",
      "Wendy", "Victoria", "Edith", "Kim", "Sherry", "Sylvia",
      "Josephine", "Thelma", "Shannon", "Sheila", "Ethel", "Ellen",
      "Elaine", "Marjorie", "Carrie", "Charlotte", "Monica", "Esther",
      "Pauline", "Emma", "Juanita", "Anita", "Rhonda", "Hazel",
      "Amber", "Eva", "Debbie", "April", "Leslie", "Clara",
      "Lucille", "Jamie", "Joanne", "Eleanor", "Valerie", "Danielle",
      "Megan", "Alicia", "Suzanne", "Michele", "Gail", "Bertha",
      "Darlene", "Veronica", "Jill", "Erin", "Geraldine", "Lauren",
      "Cathy", "Joann", "Lorraine", "Lynn", "Sally", "Regina",
      "Erica", "Beatrice", "Dolores", "Bernice", "Audrey", "Yvonne",
      "Annette", "June", "Samantha", "Marion", "Dana", "Stacy",
      "Ana", "Renee", "Ida", "Vivian", "Roberta", "Holly",
      "Brittany", "Melanie", "Loretta", "Yolanda", "Jeanette", "Laurie",
      "Katie", "Kristen", "Vanessa", "Alma", "Sue", "Elsie",
      "Beth", "Jeanne", "Vicki", "Carla", "Tara", "Rosemary",
      "Eileen", "Terri", "Gertrude", "Lucy", "Tonya", "Ella",
      "Stacey", "Wilma", "Gina", "Kristin", "Jessie", "Natalie",
      "Agnes", "Vera", "Willie", "Charlene", "Bessie", "Delores",
      "Melinda", "Pearl", "Arlene", "Maureen", "Colleen", "Allison",
      "Tamara", "Joy", "Georgia", "Constance", "Lillie", "Claudia",
      "Jackie", "Marcia", "Tanya", "Nellie", "Minnie", "Marlene",
      "Heidi", "Glenda", "Lydia", "Viola", "Courtney", "Marian",
      "Stella", "Caroline", "Dora", "Jo", "Vickie", "Mattie",
      "Terry", "Maxine", "Irma", "Mabel", "Marsha", "Myrtle",
      "Lena", "Christy", "Deanna", "Patsy", "Hilda", "Gwendolyn",
      "Jennie", "Nora", "Margie", "Nina", "Cassandra", "Leah",
      "Penny", "Kay", "Priscilla", "Naomi", "Carole", "Brandy",
      "Olga", "Billie", "Dianne", "Tracey", "Leona", "Jenny",
      "Felicia", "Sonia", "Miriam", "Velma", "Becky", "Bobbie",
      "Violet", "Kristina", "Toni", "Misty", "Mae", "Shelly",
      "Daisy", "Ramona", "Sherri", "Erika", "Katrina", "Claire"
    };
const string NAMES_MALE[] =
    { "James", "John", "Robert", "Michael", "William", "David",
      "Richard", "Charles", "Joseph", "Thomas", "Christopher", "Daniel",
      "Paul", "Mark", "Donald", "George", "Kenneth", "Steven",
      "Edward", "Brian", "Ronald", "Anthony", "Kevin", "Jason",
      "Matthew", "Gary", "Timothy", "Jose", "Larry", "Jeffrey",
      "Frank", "Scott", "Eric", "Stephen", "Andrew", "Raymond",
      "Gregory", "Joshua", "Jerry", "Dennis", "Walter", "Patrick",
      "Peter", "Harold", "Douglas", "Henry", "Carl", "Arthur",
      "Ryan", "Roger", "Joe", "Juan", "Jack", "Albert",
      "Jonathan", "Justin", "Terry", "Gerald", "Keith", "Samuel",
      "Willie", "Ralph", "Lawrence", "Nicholas", "Roy", "Benjamin",
      "Bruce", "Brandon", "Adam", "Harry", "Fred", "Wayne",
      "Billy", "Steve", "Louis", "Jeremy", "Aaron", "Randy",
      "Howard", "Eugene", "Carlos", "Russell", "Bobby", "Victor",
      "Martin", "Ernest", "Phillip", "Todd", "Jesse", "Craig",
      "Alan", "Shawn", "Clarence", "Sean", "Philip", "Chris",
      "Johnny", "Earl", "Jimmy", "Antonio", "Danny", "Bryan",
      "Tony", "Luis", "Mike", "Stanley", "Leonard", "Nathan",
      "Dale", "Manuel", "Rodney", "Curtis", "Norman", "Allen",
      "Marvin", "Vincent", "Glenn", "Jeffery", "Travis", "Jeff",
      "Chad", "Jacob", "Lee", "Melvin", "Alfred", "Kyle",
      "Francis", "Bradley", "Jesus", "Herbert", "Frederick", "Ray",
      "Joel", "Edwin", "Don", "Eddie", "Ricky", "Troy",
      "Randall", "Barry", "Alexander", "Bernard", "Mario", "Leroy",
      "Francisco", "Marcus", "Micheal", "Theodore", "Clifford", "Miguel",
      "Oscar", "Jay", "Jim", "Tom", "Calvin", "Alex",
      "Jon", "Ronnie", "Bill", "Lloyd", "Tommy", "Leon",
      "Derek", "Warren", "Darrell", "Jerome", "Floyd", "Leo",
      "Alvin", "Tim", "Wesley", "Gordon", "Dean", "Greg",
      "Jorge", "Dustin", "Pedro", "Derrick", "Dan", "Lewis",
      "Zachary", "Corey", "Herman", "Maurice", "Vernon", "Roberto",
      "Clyde", "Glen", "Hector", "Shane", "Ricardo", "Sam",
      "Rick", "Lester", "Brent", "Ramon", "Charlie", "Tyler",
      "Gilbert", "Gene", "Marc", "Reginald", "Ruben", "Brett",
      "Angel", "Nathaniel", "Rafael", "Leslie", "Edgar", "Milton",
      "Raul", "Ben", "Chester", "Cecil", "Duane", "Franklin",
      "Andre", "Elmer", "Brad", "Gabriel", "Ron", "Mitchell",
      "Roland", "Arnold", "Harvey", "Jared", "Adrian", "Karl",
      "Cory", "Claude", "Erik", "Darryl", "Jamie", "Neil",
      "Jessie", "Christian", "Javier", "Fernando", "Clinton", "Ted",
      "Mathew", "Tyrone", "Darren", "Lonnie", "Lance", "Cody",
      "Julio", "Kelly", "Kurt", "Allan", "Nelson", "Guy",
      "Clayton", "Hugh", "Max", "Dwayne", "Dwight", "Armando",
      "Felix", "Jimmie", "Everett", "Jordan", "Ian", "Wallace",
      "Ken", "Bob", "Jaime", "Casey", "Alfredo", "Alberto",
      "Dave", "Ivan", "Johnnie", "Sidney", "Byron", "Julian",
      "Isaac", "Morris", "Clifton", "Willard", "Daryl", "Ross",
      "Virgil", "Andy", "Marshall", "Salvador", "Perry", "Kirk",
      "Sergio", "Marion", "Tracy", "Seth", "Kent", "Terrance",
      "Rene", "Eduardo", "Terrence", "Enrique", "Freddie", "Wade"
    };
//
//
//************************************************************************
//Free Function Section

void ClearScreen
(
    int numLines = 25 //in
);
void DisplayOpeningScreen
(
    const string& programmerInfo = DEFAULT_PROGRAMMER_INFO, //in
    const string& programInfo = DEFAULT_PROGRAM_INFO,       //in
    int numBlankLinesBefore = 11, //in
    int numBlankLinesAfter = 12   //in
);
void DisplayTextfile
(
    const string& fileName,        //in
    int numberOfLinesPerPause = 23 //in
);
int gcd
(
    int a, //in
    int b  //in
);
bool isEven
(
    int n  //in
);
bool isOdd
(
    int n  //in
);
int numberOfDigits
(
    int n  //in
);
void Pause
(
    int indentLevel = 0,  //in
    string message = "",  //in
    int pauseNumber = 0   //in
);
void ReadChar
(
    const string& userPrompt, //in
    char& charValue           //out
);
void ReadDouble
(
    const string& userPrompt, //in
    double& doubleValue       //out
);
void ReadInt
(
    const string& userPrompt, //in
    int& intValue             //out
);
void ReadThisLine
(
    const string& userPrompt, //in
    string& lineValue         //out
);
void ReadNextLine
(
    const string& userPrompt, //in
    string& lineValue         //out
);
void ReadString
(
    const string& userPrompt, //in
    string& stringValue       //out
);
bool userSaysYes
(
    const string& question //in
);
//
//
//************************************************************************
//Utility Class Section

class Menu
{
public:

    Menu();
    Menu
    (
        const string& menuTitle //in
    );
   void setTitle
   (
       const string& menuTitle //in
   );
    void addOption
    (
        const string& option //in
    );
    void display() const;
    int getChoice
    (
        int maxNumTries = 3, //in
        string userPrompt =
        "Enter the number of your menu choice here and press Enter: " //in
    ) const;
private:
    static const int MAX_NUM_OPTIONS = 20;
    static const int MAX_OPTION_LENGTH = 70;
    static const int MAX_TITLE_LENGTH = 70;

    int numOptions;
    //Number of options currently on the menu.

    vector<string> menuText;
    //Contains the title and the options
    //Both constructors set the size of menuText to 1+MAX_NUM_OPTIONS,
    //which includes one row to hold the menu title, and MAX_NUM_OPTIONS
    //rows to hold the options.
};


class OperationCounter
{
public:

    OperationCounter();
    void reset();
    void incrementAssignments
    (
        int numTimes = 1 //in
    );
    void incrementComparisons
    (
        int numTimes = 1 //in
    );
    void incrementExchanges
    (
        int numTimes = 1 //in
    );
    void incrementOtherOp
    (
        int numTimes = 1 //in
    );
    int getNumberOfComparisons() const;
    int getNumberOfExchanges() const;
    int getNumberOfAssignments() const;
    int getNumberOfOtherOp() const;
    void setNameOfOtherOp
    (
        string nameOfOtherOp //in
    );
    string getNameOfOtherOp() const;
    void displayNonZeroCounts() const;
    void displayAllCounts() const;
private:
    int numComparisons;
    int numExchanges;
    int numAssignments;
    int numOtherOp;
    string nameOfOtherOp;
};



class RandomGenerator
{
public:

    RandomGenerator();
    RandomGenerator
    (
        int userSeedValue //in
    );
    void reset();
    void reset
    (
        int userSeedValue //in
    );
    //
    //
    //********** Random int generators **********
    int getNext
    (
        int n //in
    );
    int getNextInt
    (
        int n //in
    );
    int getNext
    (
        int low, //in
        int high //in
    );
    int getNextInt
    (
        int low, //in
        int high //in
    );
    //
    //
    //********** Random double generators **********
    double getNext
    (
        double x //in
    );
    double getNextDouble
    (
        double x //in
    );
    double getNext
    (
        double low, //in
        double high //in
    );
    double getNextDouble
    (
        double low, //in
        double high //in
    );
    //
    //
    //********** Random string generators **********
    string getNext
    (
        const string& s //in
    );
    string getNextString
    (
        const string& s //in
    );
    string getNext
    (
        const string& first, //in
        const string& second //in
    );
    string getNextString
    (
        const string& first, //in
        const string& second //in
    );
    //
    //
    //********** Auxiliary random string generators **********
    //These are public since they may also be useful to class clients.
    string getNextStringFromCharRange
    (
        int size,       //in
        char firstChar, //in
        char lastChar   //in
    );
    string getNextStringFromString
    (
        int size,            //in
        const string& source //in
    );
private:
    int seed;
    void my_srand(int& seed);
    int my_rand();
};



class Stopwatch
{
public:

    Stopwatch();
    Stopwatch
    (
        const string nameOfEventToBeTimed //in
    );
    void setEventName
    (
        const string nameOfEventToBeTimed //in
    );
    string getEventName() const;
    void start();
    void stop();
    void delay
    (
        int delayFactor = 1 //in
    ) const;
    clock_t getTicks() const;
    double getSeconds() const;
    double getMinutes() const;
    double getHours() const;
    void display() const;
private:
    clock_t numClockTicksPassed;
    string eventName;
};


class TextItems
{
public:

    TextItems();
    TextItems
    (
        const string fileName //in
    );
    void displayItem
    (
        const string title //in
    ) const;
private:
    vector< vector<string> > itemList;
};


//DisplayOpeningScreen free function
//********************************************************************
inline void DisplayOpeningScreen
(
    const string& programmerInfo, //in
    const string& programInfo,    //in
    int numBlankLinesBefore,      //in
    int numBlankLinesAfter        //in
)
{
    string blankLinesBefore(numBlankLinesBefore, '\n'),
        blankLinesAfter(numBlankLinesAfter, '\n');
    cout << blankLinesBefore
        << programmerInfo
        << "\nThis executable was built on " << __DATE__
        << " at " << __TIME__ << ".\n"
        << programInfo
        << blankLinesAfter;
    Pause();
}

} //End of this part of namespace Scobey

#endif