Changeset 33e801 for src/UIElements/CommandLineUI

Timestamp:

Jun 11, 2015, 11:21:41 PM (10 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

043598

Parents:

dd6c07

git-author:

Frederik Heber <heber@…> (05/17/15 04:22:43)

git-committer:

Frederik Heber <heber@…> (06/11/15 23:21:41)

Message:

Added ParameterPair (i.e. "key = value;") to allow other string output.

• this will solve the problem of vectors of key-value-pairs not properly converted into a single string because of missing semicolon.
• FIX: toCLIString used functions toPythonString if possible.

Location:

src/UIElements/CommandLineUI

Files:

• CommandLineDialog.cpp (modified) (1 diff)
• CommandLineDialog.hpp (modified) (2 diffs)
• CommandLineParser.cpp (modified) (2 diffs)
• CommandLineParser_validate.cpp (modified) (3 diffs)
• CommandLineParser_validate.hpp (modified) (1 diff)
• Query/CommandLineQuery.hpp (modified) (1 diff)
• Query/KeyValuePairCommandLineQuery.cpp (added)
• Query/KeyValuePairsCommandLineQuery.cpp (added)
• TypeEnumContainer.cpp (modified) (2 diffs)
• TypeEnumContainer.hpp (modified) (1 diff)

src/UIElements/CommandLineUI/CommandLineDialog.cpp

@@ -136 +136 @@
 }
 
+void CommandLineDialog::queryKeyValuePair(Parameter<KeyValuePair> &param, const std::string title, const std::string description)
+{
+  registerQuery(new KeyValuePairCommandLineQuery(param, title,description));
+}
+
+void CommandLineDialog::queryKeyValuePairs(Parameter< std::vector<KeyValuePair> > &param, const std::string title, const std::string description)
+{
+  registerQuery(new KeyValuePairsCommandLineQuery(param, title,description));
+}
+
 /************************** Query Infrastructure ************************/
 /*       ---> shifted to folder Query                                   */

src/UIElements/CommandLineUI/CommandLineDialog.hpp

@@ -54 +54 @@
   virtual void queryFile(Parameter<boost::filesystem::path> &, const std::string ="", const std::string = "");
   virtual void queryFiles(Parameter<std::vector< boost::filesystem::path> > &, const std::string ="", const std::string = "");
+  virtual void queryKeyValuePair(Parameter<KeyValuePair> &, const std::string ="", const std::string = "");
+  virtual void queryKeyValuePairs(Parameter< std::vector<KeyValuePair> > &, const std::string ="", const std::string = "");
+
   // specialized stuff for command line queries
   // all placed into Query/CommandLineQuery.hpp
   // !please adhere to alphabetical ordering!
+
   class AtomCommandLineQuery;
   class AtomsCommandLineQuery;
@@ -69 +73 @@
   class IntCommandLineQuery;
   class IntsCommandLineQuery;
+  class KeyValuePairCommandLineQuery;
+  class KeyValuePairsCommandLineQuery;
   class MoleculeCommandLineQuery;
   class MoleculesCommandLineQuery;

src/UIElements/CommandLineUI/CommandLineParser.cpp

@@ -52 +52 @@
 #include "CommandLineParser.hpp"
 #include "CommandLineParser_validate.hpp"
+#include "Parameters/Specifics/KeyValuePair.hpp"
 #include "World.hpp"
 
@@ -408 +409 @@
 //                  po::value < RealSpaceMatrixValue >()->default_value(boost::lexical_cast<BoxValue>(currentOption->getDefaultValue().c_str())) :
                   po::value < RealSpaceMatrixValue >(),
+                  currentOption->getDescription().c_str())
+        ;
+      break;
+    case TypeEnumContainer::KeyValueType:
+      OptionList->add_options()
+        (currentOption->getKeyAndShortForm().c_str(),
+            currentOption->hasDefaultValue() ?
+                  (_DefaultAsImplicit ?
+                      po::value < KeyValuePair >()->implicit_value(boost::lexical_cast< KeyValuePair >(currentOption->getDefaultValue().c_str())) :
+                      po::value < KeyValuePair >()->default_value(boost::lexical_cast< KeyValuePair >(currentOption->getDefaultValue().c_str()))) :
+                  po::value < KeyValuePair >(),
+                  currentOption->getDescription().c_str())
+        ;
+      break;
+    case TypeEnumContainer::ListOfKeyValuesType:
+      OptionList->add_options()
+        (currentOption->getKeyAndShortForm().c_str(),
+//            currentOption->hasDefaultValue() ?
+//                  po::value < std::vector<KeyValuePair> >()->default_value(boost::lexical_cast< std::vector<KeyValuePair> >(currentOption->getDefaultValue().c_str())) :
+                  po::value < std::vector<KeyValuePair> >()->multitoken(),
                   currentOption->getDescription().c_str())
         ;

src/UIElements/CommandLineUI/CommandLineParser_validate.cpp

@@ -42 +42 @@
 #include "Actions/Values.hpp"
 #include "CommandLineParser_validate.hpp"
+#include "Parameters/Specifics/KeyValuePair.hpp"
 
 /** boost::program_options validator specialization for VectorValue.
@@ -157 +158 @@
 void validate(boost::any& v, const std::vector<std::string>& values, boost::filesystem::path *, int)
 {
-  boost::filesystem::path filename;
-
-  std::cerr << "boost::filesystem::path validator used." << std::endl;
+//  std::cerr << "boost::filesystem::path validator used." << std::endl;
+
+  // Make sure no previous assignment to 'a' was made.
+  boost::program_options::validators::check_first_occurrence(v);
+  // Extract the first string from 'values'. If there is more than
+  // one string, it's an error, and exception will be thrown.
+  const std::string& s = boost::program_options::validators::get_single_string(values);
+
+  v = boost::any(boost::filesystem::path(s));
+}
+
+/** boost::program_options validator specialization for boost::filesystem::path.
+ * \param &v  reference for return value
+ * \param &values string vector of scanned options
+ * \param *
+ * \param
+ *
+ */
+void validate(boost::any& v, const std::vector<std::string>& values, KeyValuePair *, int)
+{
+//  std::cerr << "KeyValuePair validator used." << std::endl;
+
+  // Make sure no previous assignment to 'a' was made.
+  boost::program_options::validators::check_first_occurrence(v);
+  // Extract the first string from 'values'. If there is more than
+  // one string, it's an error, and exception will be thrown.
+  const std::string& s = boost::program_options::validators::get_single_string(values);
+
+  if (s.find("=") == std::string::npos) {
+#if BOOST_VERSION < 104200
+    throw boost::program_options::validation_error("Invalid KeyValue given");
+#else
+throw boost::program_options::validation_error(
+    boost::program_options::validation_error::invalid_option_value,
+    std::string("value"),
+    std::string("vector<KeyValuePair>")
+    );
+#endif
+  }
+  v = boost::any(KeyValuePair(s));
+}
+
+/** boost::program_options validator specialization for boost::filesystem::path.
+ * \param &v  reference for return value
+ * \param &values string vector of scanned options
+ * \param *
+ * \param
+ *
+ */
+void validate(boost::any& v, const std::vector<std::string>& values, std::vector<KeyValuePair> *, int)
+{
+//  std::cerr << "vector<KeyValuePair> validator used." << std::endl;
 
   // split comma-separated values
-  if (values.size() != 1) {
-    std::cerr <<  "Not one file but " << values.size() << " given " << std::endl;
+  if (values.size() > 1) {
 #if BOOST_VERSION < 104200
     throw boost::program_options::validation_error("Unequal to one file given");
@@ -171 +220 @@
           boost::program_options::validation_error::at_least_one_value_required,
           std::string("value"),
-          std::string("boost::filesystem::path")
-      );
-    } else {
-      throw boost::program_options::validation_error(
-          boost::program_options::validation_error::multiple_values_not_allowed,
-          std::string("value"),
-          std::string("boost::filesystem::path")
+          std::string("vector<KeyValuePair>")
       );
     }
 #endif
-  }
-  filename = values.at(0);
-  v = boost::any(boost::filesystem::path(filename));
-}
-
+    for (std::vector<std::string>::const_iterator iter = values.begin();
+        iter != values.end();++iter)
+      if ((*iter).find("=") == std::string::npos) {
+#if BOOST_VERSION < 104200
+    throw boost::program_options::validation_error("Invalid KeyValue given");
+#else
+    throw boost::program_options::validation_error(
+        boost::program_options::validation_error::invalid_option_value,
+        std::string("value"),
+        std::string("vector<KeyValuePair>")
+    );
+#endif
+      }
+  }
+  std::vector<KeyValuePair> temp;
+  for (std::vector<std::string>::const_iterator iter = values.begin();
+      iter != values.end();++iter)
+    temp.push_back(KeyValuePair(*iter));
+  v = boost::any(temp);
+}

src/UIElements/CommandLineUI/CommandLineParser_validate.hpp

@@ -22 +22 @@
 #include <boost/lexical_cast.hpp>
 
+struct KeyValuePair;
 class RealSpaceMatrixValue;
 class VectorValue;
 
+void validate(boost::any& v, const std::vector<std::string>& values, KeyValuePair *, int);
+void validate(boost::any& v, const std::vector<std::string>& values, std::vector<KeyValuePair> *, int);
 void validate(boost::any& v, const std::vector<std::string>& values, VectorValue *, int);
 void validate(boost::any& v, const std::vector<std::string>& values, RealSpaceMatrixValue *, int);

src/UIElements/CommandLineUI/Query/CommandLineQuery.hpp

@@ -164 +164 @@
 };
 
+class CommandLineDialog::KeyValuePairCommandLineQuery : public Dialog::TQuery<KeyValuePair> {
+public:
+  KeyValuePairCommandLineQuery(Parameter<KeyValuePair> &_param, const std::string &_title, const std::string &_description = "");
+  virtual ~KeyValuePairCommandLineQuery();
+  virtual bool handle();
+};
+
+class CommandLineDialog::KeyValuePairsCommandLineQuery : public Dialog::TQuery<std::vector<KeyValuePair> > {
+public:
+  KeyValuePairsCommandLineQuery(Parameter<std::vector<KeyValuePair> > &_param, const std::string &_title, const std::string &_description = "");
+  virtual ~KeyValuePairsCommandLineQuery();
+  virtual bool handle();
+};
+
 #endif /* COMMANDLINEQUERY_HPP_ */

src/UIElements/CommandLineUI/TypeEnumContainer.cpp

@@ -51 +51 @@
 #include "Element/element.hpp"
 #include "molecule.hpp"
+#include "Parameters/Specifics/KeyValuePair.hpp"
 #include "RandomNumbers/RandomNumberDistribution_Parameters.hpp"
 
@@ -81 +82 @@
   TypeEnumMap[&typeid(const element *)] = ElementType;
   TypeEnumMap[&typeid(std::vector<const element *>)] = ListOfElementsType;
+  TypeEnumMap[&typeid(KeyValuePair)] = KeyValueType;
+  TypeEnumMap[&typeid(std::vector<KeyValuePair>)] = ListOfKeyValuesType;
 
   // for debugging: list all stored types

src/UIElements/CommandLineUI/TypeEnumContainer.hpp

@@ -46 +46 @@
         ElementType,
         ListOfElementsType,
-        RealSpaceMatrixType
+        RealSpaceMatrixType,
+        KeyValueType,
+        ListOfKeyValuesType
   };