VR-Forces 4.3 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
scriptedTaskMetaData.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2014 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrfutil/vrfutilDefines.h"
12 #include "vrfutil/scriptedTaskVariable.h"
13 
14 #include <boost/serialization/access.hpp>
15 #include <boost/serialization/nvp.hpp>
16 #include <boost/serialization/list.hpp>
17 #include <boost/serialization/map.hpp>
18 #include <boost/serialization/vector.hpp>
19 #include <boost/serialization/string.hpp>
20 
21 #include <vlutil/vlFilename.h>
22 #include <vlpi/entityType.h>
23 
24 #include <set>
25 
32 typedef bool (*DtEncryptDecryptFcn)(const std::string& scriptId, char* input, int inputLen, char** output, int& outputLen, bool encrypt,
33  void* usr);
34 
37 const int DtScriptedTaskScriptedTask = 1;
38 const int DtScriptedTaskReactiveTask = 2;
39 const int DtScriptedTaskBackgroundProcess = 3;
40 
41 const int DtScriptedTask_AvailableToAllDoctrines = 0x00000001;
42 
43 class DT_DLL_vrfutil DtScriptedTaskMetaData
44 {
45 public:
46 
48  DtScriptedTaskMetaData();
49 
51  virtual ~DtScriptedTaskMetaData();
52 
54  DtScriptedTaskMetaData(const DtScriptedTaskMetaData& orig);
55 
57  DtScriptedTaskMetaData& operator=(const DtScriptedTaskMetaData& orig);
58 
60  virtual bool load(const DtFilename&);
61 
63  virtual bool load(const std::string&);
64 
66  virtual bool load(std::istream&);
67 
69  virtual bool hasUserEntryVariables() const;
70 
73  virtual bool save(const DtFilename&) const;
74 
76  virtual bool save(std::string&) const;
77 
79  virtual bool save(std::ostream&) const;
80 
82  virtual bool save() const;
83 
86  virtual const DtFilename& filename() const;
87 
90  virtual const std::string& scriptId() const;
91 
93  virtual void setScriptId(const std::string&);
94 
96  virtual void setScriptType(int);
97 
99  virtual int scriptType() const;
100 
103  virtual void setMenuText(const std::string&);
104  virtual const std::string& menuText() const;
106 
109  virtual void setExtendedMenuText(const std::string&);
110  virtual const std::string& extendedMenuText() const;
112 
115  virtual void setToolTip(const std::string&);
116  virtual const std::string& toolTip() const;
118 
121  virtual void setMenuIcon(const std::string&);
122  virtual const std::string& menuIcon() const;
124 
129  virtual void setVersion(double);
130  virtual double version() const;
132 
136  virtual void setPriority(int);
137  virtual int priority() const;
139 
143  virtual void setEnabled(bool);
144  virtual bool enabled() const;
146 
149  virtual bool variable(const std::string& s, DtScriptedTaskVariable& var) const;
150 
153  virtual void setScriptEngine(const std::string&);
154  virtual const std::string& scriptEngine() const;
155 
159  virtual bool isInterpretedScript() const;
161 
164  static void addInterpretedScriptEngine(const std::string&);
165  static bool isInterpretedScriptEngine(const std::string&);
167 
170  virtual void setComments(const std::string&);
171  virtual const std::string& comments() const;
173 
177  virtual void setDescription(const std::string&);
178  virtual const std::string& description() const;
180 
184  virtual void setScriptLocation(const std::string&);
185  virtual const std::string& scriptLocation() const;
187 
191  virtual void setMenuLocations(const std::vector<std::string>&);
192  virtual void addMenuLocation(const std::string&);
193  virtual void removeMenuLocation(const std::string&);
194  virtual void removeMenuLocation(int);
195  virtual const std::vector<std::string>& menuLocations() const;
196  virtual void setShowInMenu(bool);
197  virtual bool showInMenu() const;
199 
202  virtual void setToolbarLocation(const std::string&);
203  virtual const std::string& toolbarLocation() const;
204  virtual void setShowInToolbar(bool);
205  virtual bool showInToolbar() const;
207 
211  virtual void setEntityTypes(const std::vector<DtEntityType>&);
212  virtual void addEntityType(const DtEntityType&);
213  virtual void removeEntityType(const DtEntityType&);
214  virtual void removeEntityType(int);
215  virtual std::vector<DtEntityType> entityTypes() const;
216  virtual bool supportsEntityType(const DtEntityType&) const;
218 
223  virtual void setVariables(const std::vector<DtScriptedTaskVariable>&);
224  virtual void addVariable(const DtScriptedTaskVariable&);
225  virtual void insertVariableBefore(const DtScriptedTaskVariable&, const std::string& variable);
226  virtual void insertVariableBefore(const DtScriptedTaskVariable&, int i);
227  virtual void removeVariable(const std::string&);
228  virtual void removeVariable(int);
229  virtual std::vector<DtScriptedTaskVariable> variables() const;
230 
234  virtual DtRwVariableBindings* defaultVariableBindings() const;
235 
237  virtual void setupDefaultsFromBindings(const DtRwVariableBindings&);
238 
240 
243  virtual void setScript(const std::string&);
244  virtual const std::string& script() const;
245 
248  virtual bool loadScript();
249 
251  virtual bool loadScript(const std::string&);
252 
255  virtual void setIsSystemScript(bool);
256  virtual bool isSystemScript() const;
258 
261  virtual void setActionCategories(const std::set<std::string>&);
262  virtual void addActionCategory(const std::string&);
263  virtual void removeActionCategory(const std::string&);
264  virtual bool hasActionCategory(const std::string&) const;
265  virtual const std::set<std::string>& actionCategories() const;
267 
270  virtual void setDoctrines(const std::set<std::string>&);
271  virtual bool addDoctrine(const std::string&);
272  virtual bool removeDoctrine(const std::string&);
273  virtual bool supportsDoctrine(const std::string&) const;
274  virtual const std::set<std::string>& doctrines() const;
275  virtual bool renameDoctrine(const std::string& from, const std::string& to);
276  virtual void setAvailableToAllDoctrines(bool);
277  virtual bool availableToAllDoctrines() const;
279 
283  virtual void setDirectoryPath(const std::string&);
284  virtual const std::string& directoryPath() const;
286 
288  virtual void assignNewScriptId();
289 
291  virtual bool supports(const DtEntityType&) const;
292 
294  bool operator==(const DtScriptedTaskMetaData&) const;
295  bool operator!=(const DtScriptedTaskMetaData& rhs) const { return !(*this == rhs); };
296 
298  static void setEncryptDecryptFunction(DtEncryptDecryptFcn, void* usr);
299  static void getEncryptDecryptFunction(DtEncryptDecryptFcn&, void*& usr);
300 
302  virtual bool encrypt(const std::string& source, std::string& dest) const;
303 
305  virtual bool encryptScript();
306 
308  virtual bool encryptSize(const std::string& source, int& size) const;
309 
311  virtual bool decrypt(const std::string& source, std::string& dest) const;
312 
315  virtual bool decryptScript();
316 
321  virtual void setEncrypted(bool);
322  virtual bool encrypted() const;
324 
327  virtual void setFlag(int, bool);
328  virtual bool flagSet(int) const;
330 
336  virtual void loadTranslationFile(const std::string& lang);
337  virtual void translationData(char*& data, unsigned int& len) const;
338  virtual std::string translationLanguage() const;
339  virtual void clearTranslationData();
341 
342 protected:
343 
345  friend class boost::serialization::access;
346 
350  template<class Archive>
351  void serialize(Archive & ar, const unsigned int version)
352  {
353  ar & BOOST_SERIALIZATION_NVP(myScriptId);
354  ar & BOOST_SERIALIZATION_NVP(myMenuText);
355  ar & BOOST_SERIALIZATION_NVP(myToolTip);
356  ar & BOOST_SERIALIZATION_NVP(myMenuIcon);
357  ar & BOOST_SERIALIZATION_NVP(myVersion);
358  ar & BOOST_SERIALIZATION_NVP(myScriptEngine);
359  ar & BOOST_SERIALIZATION_NVP(myComments);
360  ar & BOOST_SERIALIZATION_NVP(myMenuLocations);
361  ar & BOOST_SERIALIZATION_NVP(myIsSystemScript);
362  ar & BOOST_SERIALIZATION_NVP(myDescription);
363  ar & BOOST_SERIALIZATION_NVP(myScriptLocation);
364  ar & BOOST_SERIALIZATION_NVP(myDirectoryPath);
365  ar & BOOST_SERIALIZATION_NVP(myEntityTypes);
366  ar & BOOST_SERIALIZATION_NVP(myVariables);
367  ar & BOOST_SERIALIZATION_NVP(myScript);
368 
369  if (version >= 2)
370  {
371  ar & BOOST_SERIALIZATION_NVP(myActionCategories);
372 
373  if (version >= 3)
374  {
375  ar & BOOST_SERIALIZATION_NVP(myShowInMenu);
376  }
377 
378  if (version >= 4)
379  {
380  ar & BOOST_SERIALIZATION_NVP(myEncrypted);
381  }
382 
383  if (version >= 5)
384  {
385  ar & BOOST_SERIALIZATION_NVP(myScriptType);
386  }
387  else
388  {
389  myScriptType = DtScriptedTaskScriptedTask;
390  }
391 
392  if (version >= 6)
393  {
394  ar & BOOST_SERIALIZATION_NVP(myDoctrines);
395  ar & BOOST_SERIALIZATION_NVP(myFlags);
396  }
397  else
398  {
399  myFlags = DtScriptedTask_AvailableToAllDoctrines;
400  }
401 
402  if (version >= 7)
403  {
404  ar & BOOST_SERIALIZATION_NVP(myShowInToolbar);
405  ar & BOOST_SERIALIZATION_NVP(myToolbarLocation);
406  }
407 
408  if (version >= 8)
409  {
410  ar & BOOST_SERIALIZATION_NVP(myExtendedMenuText);
411  }
412  }
413  }
414 
415 public:
416  std::string myScriptId;
417  std::string myMenuText;
418  std::string myExtendedMenuText;
419  std::string myToolTip;
420  std::string myMenuIcon;
421  std::string myScriptEngine;
422  std::string myComments;
423  std::string myDescription;
424  std::string myScriptLocation;
425  mutable std::string myScript;
426  std::string myDirectoryPath;
427  std::vector<std::string> myMenuLocations;
428  std::vector<std::string> myEntityTypes;
429  std::vector<std::string> myVariables;
430  std::string myActionCategories;
431  std::string myDoctrines;
432  bool myShowInMenu;
433 
434  std::string myToolbarLocation;
435  bool myShowInToolbar;
436 
437  mutable std::set<std::string> myActionCategoriesSet;
438  mutable std::set<std::string> myDoctrinesSet;
439 
440  double myVersion;
441  mutable DtFilename myFile;
442  bool myIsSystemScript;
443  mutable bool myEncrypted;
444 
445  static DtEncryptDecryptFcn theEncryptDecryptFunction;
446  static void* theEncryptDecryptUserData;
447 
448  int myScriptType;
449  int myFlags;
450 
451  char* myTranslationData;
452  DtU64 myTranslationDataLen;
453  std::string myTranslationLanguage;
454 
455  static std::vector<std::string> theInterpretedScriptEngines;
456 };
457 
458 namespace DtBufferSerialize
459 {
460  DT_DLL_vrfutil int getSize(const DtScriptedTaskMetaData& v);
461  DT_DLL_vrfutil char *encode(const DtScriptedTaskMetaData& val, char *buffer);
462  DT_DLL_vrfutil const char *decode(DtScriptedTaskMetaData& val, const char *buffer);
463 }
464 
465 BOOST_CLASS_VERSION(DtScriptedTaskMetaData, 8)
Document ID: Generated on Wed Mar 11 21:20:57 EDT 2015 from SVN revision 150940
Copyright © 2005-2014 VT MÄK. All Rights Reserved (www.mak.com)