Diffpack Documentation

---

              Search  

---

MenuSystem.h

Go to the documentation of this file.

class MenuSystem : public HandleId

{

  friend class PromptBase;

private:
  void promptSequential ();
  
  Handle(PromptBase) parallel_prompt; 

protected:
  VecSimplest(Handle(MenuLists)) menu_lists;  
  bool initialized;                           

  MenuAnswerTable table;
  bool disable_add_and_prompt;
  bool is_inside_multiple_loop;
  String command_prefix;
  String save_input_to_file;

  int ncomb;           
  int icomb;           

  String about_image;
  String about_text;
  int    about_width;
  int    about_height;

public:
  MenuSystem ();
 ~MenuSystem ();

  void init (const String& description, const String& label);

  MenuItemBase* addItem
    (
           int       level,             
     const String&   command,           
     const String&   cl_option_string,  
     const String&   description,       
     const String&   default_answer,    
     const String&   valid_answer,      
           char      hot_key,           
           char      cl_option_char,    
           MenuCallBack* func = NULL    
    );

  MenuItemBase* addItem
    (
           int       level,             
     const String&   command,           
     const String&   cl_option_string,  
     const String&   description,       
     const String&   default_answer,    
     const String&   valid_answer,      
           MenuCallBack* func = NULL    
    );

  MenuItemBase* addItem                 
    (
           int       level,             
     const String&   command,           
     const String&   description,       
     const String&   default_answer     
    );

  bool addSubMenu
    (
           int     level,        
     const String& name_label,   
     const String& command,      
     const String& description,  
           char    hot_key       
    );

  bool addSubMenu
    (
           int     level,        
     const String& name_label,   
     const String& command,      
     const String& description   
    );

  bool addSubMenu (MenuSystem* menu); 

  bool disableIfEqual(String item_boss, String value, String item_disable);

  void forget ();

#if defined(WIN32) && defined(MFCDP_MENUS)
  
  void reinitForNextRun();
#endif

  void prompt(); 

  StringList answers;  
  void forceAnswer (const String& command_and_answer);

  String get (const String& command);
  void   set (const String& command, const String& value);

  void setAboutImage(const String& path) { about_image = path; }
  void setAboutText (const String& text) { about_text  = text; }
  void setAboutGeometry (int width, int height) 
    { about_width=width; about_height=height; }

  String getAboutImage()  const { return about_image;  }
  String getAboutText()   const { return about_text;   }
  int    getAboutWidth()  const { return about_width;  }
  int    getAboutHeight() const { return about_height; }
  
  void print4awk (Os os);        

  void multipleLoop (SimCase& user);

  bool insideMultipleLoop  () const { return is_inside_multiple_loop; }
  int getMultipleLoopLimit () const { return ncomb;                   }
  int getMultipleLoopIndex () const { return icomb;                   }

  void   setCommandPrefix (const String& prefix);
  void unsetCommandPrefix ();
  String getCommandPrefix () const;

  bool ok () const;
  bool empty () const;

  void writeHeadings4multipleAnswers (StringList& headings);
  void writeResults4multipleAnswers  (StringList& results);
  void writeExtendedResults4multipleAnswers (MultipleReporter& rep,
                                             int section_level = 1 /*0*/);
  static void makeSubMenuHeader
    (
           MenuSystem&  menu,
     const String&      description,
     const String&      command,
           int&         level,
           char         hot_key
    );

  String getDescription() const {return menu_lists(1)->description;}
  MenuItemBase* getFirstItem();

  
  void initParallelPrompt (const PromptBase& p) { parallel_prompt.rebind(p); }
  
protected:
  
  void search4multipleAnswers (MenuAnswerTable& table);

  MenuLists* getMenuListsPtr();
  bool levelCheck(int level);
  
  
  
  SetDistinct(String) init_from_command_line_options;
  StringList          init_from_command_line_defaults;
  StringList          init_from_command_line_descriptions;
  StringList          init_from_command_line_vartypes;

public:

#if defined(WIN32) && defined(MFCDP_MENUS)
  MenuLists*  getMFCListsPtr();
#endif

  bool initFromCommandLineArg
     (const char* option, real& number, real default_value,
      const char* description = NULL, const char* variable_type = NULL);
  bool initFromCommandLineArg
     (const char* option, int& number, int default_value,
      const char* description = NULL, const char* variable_type = NULL);
  bool initFromCommandLineArg
     (const char* option, bool& indicator, bool default_value,
      const char* description = NULL, const char* variable_type = NULL);
  bool initFromCommandLineArg
     (const char* option, String& string, const char* default_value,
      const char* description = NULL, const char* variable_type = NULL);
};






inline bool initFromCommandLineArg (const char* option, 
                                    real& number, 
                                    real default_value,
                                    const char* description = NULL, 
                                    const char* variable_type = NULL)
{ 
  return global_menu.initFromCommandLineArg (option, number, default_value,
                                             description, variable_type); 
}

inline bool initFromCommandLineArg (const char* option, 
                                    int& number, 
                                    int default_value,
                                    const char* description = NULL, 
                                    const char* variable_type = NULL)
{ 
  return global_menu.initFromCommandLineArg (option, number, default_value,
                                             description, variable_type); 
}

inline bool initFromCommandLineArg (const char* option,
                                    bool& indicator,
                                    bool default_value,
                                    const char* description = NULL,
                                    const char* variable_type = NULL)
{ 
  return global_menu.initFromCommandLineArg (option, indicator,
                                             default_value,
                                             description, variable_type);
}

inline bool initFromCommandLineArg (const char* option,
                                    String& string,
                                    const char* default_value,
                                    const char* description = NULL,
                                    const char* variable_type = NULL)
{ 
  return global_menu.initFromCommandLineArg (option, string, default_value,
                                             description, variable_type);
}


extern String validationString (const char** legal_names);  
extern String validationString (const StringList& legal_names);

) 
       see documentation of the function
       "writeHeadings4multipleAnswers". The value of the menu items
       that are varied in a multiple loop is written in a separate
       section in the report. The extra argument "section_level"
       determines the level of the section; 0 means a section, and 1
       means a subsection. For stand-alone solvers, 1 is appropriate,
       while 0 is used when solvers are combined (system of PDEs),
       because then it is appropriate with a common section with the
       multiple loop parameters before each solver presents its
       specific part of the report.

*/

---