/home/serif/byzantine_generals/src/main.cpp

/*
 * @file main.cpp
 * @author Reshen Amin <reshen@zensrc.com>
 *
 * @brief Main Entry point for Byzantine Generals Coding Sample
 *
 * @license Byzantine Generals Problem Coding Sample.<br>
 * Copyright (C) 2010  Reshen Amin.<br>
 * See @ref license_sec for details.<br>
 */

/*! \mainpage Byzantine Generals Coding Sample
 *
 * @author Reshen Amin <reshen@zensrc.com>
 *
 *
 * \section note_sec General Notes
 *
 * - A digital copy of the source code for this coding sample is available under
 * version control at <http://bitbucket.org/reshen/byzantine_generals/src>.
 *
 * - Generally speaking, the Google C++ Style Guide was used for this coding
 * sample, it is available at
 * <http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml>.
 *
 * - The source code has been marked up with Doxygen style commenting, which can
 * make for much easier navigation.  The generated doxygen output can be viewed
 * at <http://zensrc.com/byzgen_doxygen/html/index.html>
 *
 *
 * \section intro_sec Byzantine Generals Introduction
 *
 * This simple program demonstrates the Byzantine Generals Problem in which
 * multiple generals of the Byzantine Empire's army need to coordinate to attack
 * or retreat from a city. They believe that either some of the other Generals
 * or their Messengers are traitors and may corrupt Orders passed between them,
 * yet they still need to coordinate to all come to the same course of action.
 *
 * For a good synopsis of the problem, see either Wikipedia
 * <http://en.wikipedia.org/wiki/Byzantine_generals> or
 * Byzantine Generals Problem by Mark Nelson at
 * <http://marknelson.us/2007/07/23/byzantine/>.
 *
 * For a solution to exist, we must:
 *
 *  -# Terminate - all loyal generals need to reach a decision regarding the
 *     orders they've been given.
 *  -# Agree - all loyal generals have to agree on the decision they are making.
 *  -# Valid - all loyal generals have to agree on the value they have been
 *     given by their commanding general if and only if the commanding general
 *     is loyal.
 *
 *
 * \section build_dep_sec Build Dependencies
 *
 *  -# a2ps / ps2pdf - for printing of source code
 *  -# Boost
 *  -# cppcheck - for static analysis of code during compilation
 *  -# Doxygen - for doxygen documentation
 *  -# etags - for TAGS generation over source code
 *  -# GNU Make
 *  -# GNU poject C++ compiler
 *  -# Graphviz / dot - for graph generation
 *  -# Log4cpp
 *  -# Valgrind - for memory self tests
 *
 *
 * \section build_targets_sec Build Targets
 *
 * See 'make help' for latest target options.
 *
 * \section usage_sec Example Usage
 *
 * The following example demonstrates 5 loyal generals and 2 disloyal generals.
 *
 * \verbinclude tree.txt
 *
 * The graph below shows the output from General #1's communication tree.  As
 * each message is received, it is added to the tree using the communication
 * path contained therein.  The communication path is simply an ordered list of
 * each General who touched that particular message.  The second line, labeled
 * Rx, shows what the order was when the message was received.  The third line,
 * labeled Vote, is a majority vote of all of the node's childrens' Rx fields.
 * Each level in the tree represents all of the messages sent during that round
 * of communication. Nodes that are colored pink are messages that have passed
 * through at least one disloyal general.  The white nodes should always
 * outnumber the pink nodes, indicating that despite the disloyal generals best
 * efforts, a deterministic outcome is always possible.
 *
 * <center>
 * \dotfile tree.dot
 * [ <a href="tree.pdf">PDF</a> ]
 * </center>
 *
 * \section license_sec License
 *
 * Byzantine Generals Problem Coding Sample<br>
 * Copyright (C) 2010  Reshen Amin<br>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

/* Order of includes is always <current_file>.h, C library, C++ library,
 * other libraries' .h, project's .h */

#include <stdio.h>

#include <exception>

#include "clihandler.h"

int main(int argc, char* argv[]) {
    printf("Byzantine Generals Problem Coding Sample\n"
           "Copyright (C) 2010  Reshen Amin <reshen@zensrc.com>\n"
           "This program comes with ABSOLUTELY NO WARRANTY; This is free\n"
           "software, and you are welcome to redistribute it under certain\n"
           "conditions; See the GNU General Public License for more\n"
           "details.\n\n");

    ByzGeneralsReturnCodes::type result = ByzGeneralsReturnCodes::kNoError;

    try {
        CLIHandler handler;
        result = handler.Exec(argc, argv);
    }
    catch(const std::invalid_argument& e) {
        fprintf(stderr, "Invalid argument error: %s\n"
                "Try `%s --help` for more information", e.what(), argv[0]);

        result = ByzGeneralsReturnCodes::kInvalidInput;
    }
    catch(const std::exception& e) {
        fprintf(stderr, "Exception: %s\n", e.what());

        result = ByzGeneralsReturnCodes::kUnknown;
    }
    catch(...) {
        fprintf(stderr, "Exception of unknown type!");

        result = ByzGeneralsReturnCodes::kUnknown;
    }

    return result;
}

---