Changeset 1849

Timestamp:

21/09/2007 20:48:23 (4 years ago)

Author:

chris

Message:

Refactor out command-line option processing, so that it can be extended
by subclasses.

Location:

box/chris/general/lib/server

Files:

• Daemon.cpp (modified) (5 diffs)
• Daemon.h (modified) (3 diffs)

box/chris/general/lib/server/Daemon.cpp

@@ -51 +51 @@
           mSingleProcess(false),
           mRunInForeground(false),
-          mKeepConsoleOpenAfterFork(false)
+          mKeepConsoleOpenAfterFork(false),
+          mHaveConfigFile(false);
 {
         if(spDaemon != NULL)
@@ -88 +89 @@
 //
 // Function
+//              Name:    Daemon::GetOptionString()
+//              Purpose: Returns the valid Getopt command-line options.
+//                       This should be overridden by subclasses to add
+//                       their own options, which should override 
+//                       ProcessOption, handle their own, and delegate to
+//                       ProcessOption for the standard options.
+//              Created: 2007/09/18
+//
+// --------------------------------------------------------------------------
+std::string Daemon::GetOptionString()
+{
+        return "c:DFqvVt:Tk";
+}
+
+// --------------------------------------------------------------------------
+//
+// Function
+//              Name:    Daemon::ProcessOption(int option)
+//              Purpose: Processes the supplied option (equivalent to the
+//                       return code from getopt()). Return zero if the
+//                       option was handled successfully, or nonzero to
+//                       abort the program with that return value.
+//              Created: 2007/09/18
+//
+// --------------------------------------------------------------------------
+int Daemon::ProcessOption(signed int option)
+{
+        switch(option)
+        {
+                case 'c':
+                {
+                        mConfigFileName = optarg;
+                        mHaveConfigFile = true;
+                }
+                break;
+
+                case 'D':
+                {
+                        mSingleProcess = true;
+                }
+                break;
+
+                case 'F':
+                {
+                        mRunInForeground = true;
+                }
+                break;
+
+                case 'q':
+                {
+                        if(mLogLevel == Log::NOTHING)
+                        {
+                                BOX_FATAL("Too many '-q': "
+                                        "Cannot reduce logging "
+                                        "level any more");
+                                return 2;
+                        }
+                        mLogLevel--;
+                }
+                break;
+
+                case 'v':
+                {
+                        if(mLogLevel == Log::EVERYTHING)
+                        {
+                                BOX_FATAL("Too many '-v': "
+                                        "Cannot increase logging "
+                                        "level any more");
+                                return 2;
+                        }
+                        mLogLevel++;
+                }
+                break;
+
+                case 'V':
+                {
+                        mLogLevel = Log::EVERYTHING;
+                }
+                break;
+
+                case 't':
+                {
+                        Console::SetTag(optarg);
+                }
+                break;
+
+                case 'T':
+                {
+                        Console::SetShowTime(true);
+                }
+                break;
+
+                case 'k':
+                {
+                        mKeepConsoleOpenAfterFork = true;
+                }
+                break;
+
+                case '?':
+                {
+                        BOX_FATAL("Unknown option on command line: " 
+                                << "'" << (char)optopt << "'");
+                        return 2;
+                }
+                break;
+
+                default:
+                {
+                        BOX_FATAL("Unknown error in getopt: returned "
+                                << "'" << option << "'");
+                        return 1;
+                }
+        }
+
+        return 0;
+}
+
+// --------------------------------------------------------------------------
+//
+// Function
 //              Name:    Daemon::Main(const char *, int, const char *[])
 //              Purpose: Parses command-line options, and then calls
@@ -99 +220 @@
         // Find filename of config file
         mConfigFileName = DefaultConfigFile;
-        bool haveConfigFile = false;
 
         #ifdef NDEBUG
-        int masterLevel = Log::NOTICE; // need an int to do math with
+        mLogLevel = Log::NOTICE; // need an int to do math with
         #else
-        int masterLevel = Log::INFO; // need an int to do math with
+        mLogLevel = Log::INFO; // need an int to do math with
         #endif
 
@@ -119 +239 @@
         #endif
 
-        while((c = getopt(argc, (char * const *)argv, "c:DFqvVt:Tk")) != -1)
-        {
-                switch(c)
-                {
-                        case 'c':
-                        {
-                                mConfigFileName = optarg;
-                                haveConfigFile = true;
-                        }
-                        break;
-
-                        case 'D':
-                        {
-                                mSingleProcess = true;
-                        }
-                        break;
-
-                        case 'F':
-                        {
-                                mRunInForeground = true;
-                        }
-                        break;
-
-                        case 'q':
-                        {
-                                if(masterLevel == Log::NOTHING)
-                                {
-                                        BOX_FATAL("Too many '-q': "
-                                                "Cannot reduce logging "
-                                                "level any more");
-                                        return 2;
-                                }
-                                masterLevel--;
-                        }
-                        break;
-
-                        case 'v':
-                        {
-                                if(masterLevel == Log::EVERYTHING)
-                                {
-                                        BOX_FATAL("Too many '-v': "
-                                                "Cannot increase logging "
-                                                "level any more");
-                                        return 2;
-                                }
-                                masterLevel++;
-                        }
-                        break;
-
-                        case 'V':
-                        {
-                                masterLevel = Log::EVERYTHING;
-                        }
-                        break;
-
-                        case 't':
-                        {
-                                Console::SetTag(optarg);
-                        }
-                        break;
-
-                        case 'T':
-                        {
-                                Console::SetShowTime(true);
-                        }
-                        break;
-
-                        case 'k':
-                        {
-                                mKeepConsoleOpenAfterFork = true;
-                        }
-                        break;
-
-                        case '?':
-                        {
-                                BOX_FATAL("Unknown option on command line: " 
-                                        << "'" << (char)optopt << "'");
-                                return 2;
-                        }
-                        break;
-
-                        default:
-                        {
-                                BOX_FATAL("Unknown error in getopt: returned "
-                                        << "'" << c << "'");
-                                return 1;
-                        }
-                }
-        }
-
-        if (argc > optind && !haveConfigFile)
+        while((c = getopt(argc, (char * const *)argv, 
+                GetOptionString().c_str())) != -1)
+        {
+                int returnCode = ProcessOption(c);
+
+                if (returnCode != 0)
+                {
+                        return returnCode;
+                }
+        }
+
+        if (argc > optind && !mHaveConfigFile)
         {
                 mConfigFileName = argv[optind]; optind++;
@@ -226 +267 @@
         }
 
-        Logging::SetGlobalLevel((Log::Level)masterLevel);
+        Logging::SetGlobalLevel((Log::Level)mLogLevel);
 
         return Main(mConfigFileName);

box/chris/general/lib/server/Daemon.h

@@ -68 +68 @@
         box_time_t GetLoadedConfigModifiedTime() const;
         bool IsSingleProcess() { return mSingleProcess; }
+        std::string GetOptionString();
+        int ProcessOption(signed int option);
         
 private:
@@ -73 +75 @@
         box_time_t GetConfigFileModifiedTime() const;
         
-private:
         std::string mConfigFileName;
         Configuration *mpConfiguration;
@@ -82 +83 @@
         bool mRunInForeground;
         bool mKeepConsoleOpenAfterFork;
+        bool mHaveConfigFile;
+        int mLogLevel; // need an int to do math with
         static Daemon *spDaemon;
 };