dali/internal/system/common/command-line-options.h

   1 #ifndef __DALI_INTERNAL_COMMAND_LINE_OPTIONS_H__
   2 #define __DALI_INTERNAL_COMMAND_LINE_OPTIONS_H__
   3
   4 /*
   5  * Copyright (c) 2018 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23 #include <cstdint> // int32_t
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal
  29 {
  30
  31 namespace Adaptor
  32 {
  33
  34 /**
  35  * Parses the passed command line arguments and sets the values stored within this
  36  * class appropriately.
  37  *
  38  * The following options are supported:
  39  *
  40  * @code
  41  *     --no-vsync       Disable VSync on Render
  42  *  -w|--width          Stage Width
  43  *  -h|--height         Stage Height
  44  *  -d|--dpi            Emulated DPI
  45  *     --help           Help
  46  * @endcode
  47  *
  48  * When the above options are found, they are stripped from argv, and argc is updated appropriately.
  49  */
  50 struct CommandLineOptions
  51 {
  52 public:
  53
  54   /**
  55    * Constructor
  56    * @param[in,out]  argc  The number of arguments
  57    * @param[in,out]  argv  The argument list
  58    * @note Supported options are stripped from argv, and argc is updated appropriately.
  59    */
  60   CommandLineOptions( int32_t *argc, char **argv[] );
  61
  62   /**
  63    * Destructor
  64    */
  65   ~CommandLineOptions();
  66
  67 public: // Command line parsed values
  68
  69   int32_t noVSyncOnRender; ///< If 1, then the user does not want VSync on Render
  70   int32_t stageWidth;      ///< The width of the stage required.  0 if not set.
  71   int32_t stageHeight;     ///< The height of the stage required.   0 if not set.
  72   std::string stageDPI;    ///< DPI stored as hxv, where h is horizontal DPI and v is vertical DPI
  73 };
  74
  75 } // namespace Adaptor
  76
  77 } // namespace Internal
  78
  79 } // namespace Dali
  80
  81 #endif // __DALI_INTERNAL_COMMAND_LINE_OPTIONS_H__