Verovio
Source code documentation
options.h
1 // Name: options.h
3 // Author: Laurent Pugin
4 // Created: 2005
5 // Copyright (c) Authors and others. All rights reserved.
7 
8 #ifndef __VRV_OPTIONS_H__
9 #define __VRV_OPTIONS_H__
10 
11 #ifdef CUSTOM_VEROVIO_OPTIONS
12 #include "custom_options.h"
13 #else
14 
15 #include <map>
16 #include <string>
17 #include <vector>
18 
19 //----------------------------------------------------------------------------
20 
21 #include "attalternates.h"
22 #include "atttypes.h"
23 #include "smufl.h"
24 #include "vrvdef.h"
25 
26 //----------------------------------------------------------------------------
27 
28 #include "jsonxx.h"
29 
30 //----------------------------------------------------------------------------
31 
32 namespace vrv {
33 
34 class OptionGrp;
35 
36 //----------------------------------------------------------------------------
37 // Default scaling (%) and spacing (units) values
38 //----------------------------------------------------------------------------
39 
40 #define DEFAULT_SCALE 100
41 #define MIN_SCALE 1
42 #define MAX_SCALE 1000
43 
44 //----------------------------------------------------------------------------
45 // Options
46 //----------------------------------------------------------------------------
47 
48 // the space between each lyric line in units
49 #define TEMP_LYRIC_LINE_SPACE 5.0
50 // the key signature spacing factor
51 #define TEMP_KEYSIG_STEP 0.4
52 // the key signature spacing factor for natural (usually slighly larger)
53 #define TEMP_KEYSIG_NATURAL_STEP 0.6
54 
55 //----------------------------------------------------------------------------
56 // Option defines
57 //----------------------------------------------------------------------------
58 
59 enum option_BREAKS { BREAKS_none = 0, BREAKS_auto, BREAKS_line, BREAKS_smart, BREAKS_encoded };
60 
61 enum option_CONDENSE { CONDENSE_none = 0, CONDENSE_auto, CONDENSE_all, CONDENSE_encoded };
62 
63 enum option_DURATION_EQ { DURATION_EQ_brevis = 0, DURATION_EQ_semibrevis, DURATION_EQ_minima };
64 
65 enum option_ELISION {
66  ELISION_regular = SMUFL_E551_lyricsElision,
67  ELISION_narrow = SMUFL_E550_lyricsElisionNarrow,
68  ELISION_wide = SMUFL_E552_lyricsElisionWide,
69  ELISION_unicode = UNICODE_UNDERTIE
70 };
71 
72 enum option_FONT_FALLBACK { FONT_FALLBACK_Leipzig = 0, FONT_FALLBACK_Bravura };
73 
74 enum option_FOOTER { FOOTER_none = 0, FOOTER_auto, FOOTER_encoded, FOOTER_always };
75 
76 enum option_HEADER { HEADER_none = 0, HEADER_auto, HEADER_encoded };
77 
78 enum option_LIGATURE_OBL { LIGATURE_OBL_auto = 0, LIGATURE_OBL_straight, LIGATURE_OBL_curved };
79 
80 enum option_MULTIRESTSTYLE {
81  MULTIRESTSTYLE_auto = 0,
82  MULTIRESTSTYLE_default,
83  MULTIRESTSTYLE_block,
84  MULTIRESTSTYLE_symbols
85 };
86 
87 enum option_SYSTEMDIVIDER { SYSTEMDIVIDER_none = 0, SYSTEMDIVIDER_auto, SYSTEMDIVIDER_left, SYSTEMDIVIDER_left_right };
88 
89 enum option_SMUFLTEXTFONT { SMUFLTEXTFONT_embedded = 0, SMUFLTEXTFONT_linked, SMUFLTEXTFONT_none };
90 
91 //----------------------------------------------------------------------------
92 // Option
93 //----------------------------------------------------------------------------
94 
95 enum class OptionsCategory { None, Base, General, Json, Layout, Mensural, Margins, Midi, Selectors, Full };
96 
100 class Option {
101 public:
102  // constructors and destructors
103  Option()
104  {
105  m_shortOption = 0;
106  m_isCmdOnly = false;
107  }
108  virtual ~Option() {}
109  virtual void CopyTo(Option *option) = 0;
110 
111  void SetKey(const std::string &key) { m_key = key; }
112  std::string GetKey() const { return m_key; }
113 
114  virtual bool SetValueBool(bool value);
115  virtual bool SetValueDbl(double value);
116  virtual bool SetValueArray(const std::vector<std::string> &values);
117  virtual bool SetValue(const std::string &value);
118  virtual std::string GetStrValue() const = 0;
119  virtual std::string GetDefaultStrValue() const = 0;
120 
121  virtual void Reset() = 0;
122  virtual bool IsSet() const = 0;
123 
124  void SetInfo(const std::string &title, const std::string &description);
125  std::string GetTitle() const { return m_title; }
126  std::string GetDescription() const { return m_description; }
127 
128  void SetShortOption(char shortOption, bool isCmdOnly);
129  char GetShortOption() const { return m_shortOption; }
130  bool IsCmdOnly() const { return m_isCmdOnly; }
131  virtual bool IsArgumentRequired() const { return true; }
132 
136  jsonxx::Object ToJson() const;
137 
138 public:
139  //----------------//
140  // Static members //
141  //----------------//
142 
146  static const std::map<int, std::string> s_breaks;
147  static const std::map<int, std::string> s_condense;
148  static const std::map<int, std::string> s_durationEq;
149  static const std::map<int, std::string> s_elision;
150  static const std::map<int, std::string> s_fontFallback;
151  static const std::map<int, std::string> s_footer;
152  static const std::map<int, std::string> s_header;
153  static const std::map<int, std::string> s_ligatureOblique;
154  static const std::map<int, std::string> s_multiRestStyle;
155  static const std::map<int, std::string> s_pedalStyle;
156  static const std::map<int, std::string> s_systemDivider;
157  static const std::map<int, std::string> s_smuflTextFont;
158 
159 protected:
160  std::string m_title;
161  std::string m_description;
162 
163 private:
164  std::string m_key;
165  /* the character for a short option - not set (0) by default) */
166  char m_shortOption;
167  /* a flag indicating that the option is available only on the command line */
168  bool m_isCmdOnly;
169 };
170 
171 //----------------------------------------------------------------------------
172 // OptionBool
173 //----------------------------------------------------------------------------
174 
178 class OptionBool : public Option {
179 public:
180  // constructors and destructors
181  OptionBool() { m_defaultValue = false; }
182  virtual ~OptionBool() {}
183  void CopyTo(Option *option) override;
184  void Init(bool defaultValue);
185 
186  bool SetValueBool(bool value) override;
187  bool SetValueDbl(double value) override;
188  bool SetValue(const std::string &value) override;
189  std::string GetStrValue() const override;
190  std::string GetDefaultStrValue() const override;
191 
192  void Reset() override;
193  bool IsSet() const override;
194 
195  bool GetValue() const { return m_value; }
196  bool GetDefault() const { return m_defaultValue; }
197  bool SetValue(bool value);
198 
199  bool IsArgumentRequired() const override { return false; }
200 
201 private:
202  //
203 public:
204  //
205 private:
206  bool m_value;
207  bool m_defaultValue;
208 };
209 
210 //----------------------------------------------------------------------------
211 // OptionDbl
212 //----------------------------------------------------------------------------
213 
217 class OptionDbl : public Option {
218 public:
219  // constructors and destructors
220  OptionDbl()
221  {
222  m_defaultValue = 0.0;
223  m_minValue = 0.0;
224  m_maxValue = 0.0;
225  m_definitionFactor = false;
226  }
227  virtual ~OptionDbl() {}
228  void CopyTo(Option *option) override;
229  void Init(double defaultValue, double minValue, double maxValue, bool definitionFactor = false);
230 
231  bool SetValueDbl(double value) override;
232  bool SetValue(const std::string &value) override;
233  std::string GetStrValue() const override;
234  std::string GetDefaultStrValue() const override;
235 
236  void Reset() override;
237  bool IsSet() const override;
238 
239  double GetValue() const;
240  double GetUnfactoredValue() const;
241  double GetDefault() const { return m_defaultValue; }
242  double GetMin() const { return m_minValue; }
243  double GetMax() const { return m_maxValue; }
244  bool SetValue(double value);
245 
246 private:
247  //
248 public:
249  //
250 private:
251  double m_value;
252  double m_defaultValue;
253  double m_minValue;
254  double m_maxValue;
255  bool m_definitionFactor;
256 };
257 
258 //----------------------------------------------------------------------------
259 // OptionInt
260 //----------------------------------------------------------------------------
261 
265 class OptionInt : public Option {
266 public:
267  // constructors and destructors
268  OptionInt()
269  {
270  m_defaultValue = 0;
271  m_minValue = 0;
272  m_maxValue = 0;
273  m_definitionFactor = false;
274  }
275  virtual ~OptionInt() {}
276  void CopyTo(Option *option) override;
277  void Init(int defaultValue, int minValue, int maxValue, bool definitionFactor = false);
278 
279  bool SetValueDbl(double value) override;
280  bool SetValue(const std::string &value) override;
281  std::string GetStrValue() const override;
282  std::string GetDefaultStrValue() const override;
283 
284  void Reset() override;
285  bool IsSet() const override;
286 
287  int GetValue() const;
288  int GetUnfactoredValue() const;
289  int GetDefault() const { return m_defaultValue; }
290  int GetMin() const { return m_minValue; }
291  int GetMax() const { return m_maxValue; }
292  bool SetValue(int value);
293 
294 private:
295  //
296 public:
297  //
298 private:
299  int m_value;
300  int m_defaultValue;
301  int m_minValue;
302  int m_maxValue;
303  bool m_definitionFactor;
304 };
305 
306 //----------------------------------------------------------------------------
307 // OptionString
308 //----------------------------------------------------------------------------
309 
313 class OptionString : public Option {
314 public:
315  // constructors and destructors
316  OptionString() {}
317  virtual ~OptionString() {}
318  void CopyTo(Option *option) override;
319  void Init(const std::string &defaultValue);
320 
321  bool SetValue(const std::string &value) override;
322  std::string GetStrValue() const override { return m_value; }
323  std::string GetDefaultStrValue() const override { return m_defaultValue; }
324 
325  std::string GetValue() const { return m_value; }
326  std::string GetDefault() const { return m_defaultValue; }
327 
328  void Reset() override;
329  bool IsSet() const override;
330 
331 private:
332  //
333 public:
334  //
335 private:
336  std::string m_value;
337  std::string m_defaultValue;
338 };
339 
340 //----------------------------------------------------------------------------
341 // OptionArray
342 //----------------------------------------------------------------------------
343 
347 class OptionArray : public Option {
348 public:
349  // constructors and destructors
350  OptionArray() {}
351  virtual ~OptionArray() {}
352  void CopyTo(Option *option) override;
353  void Init();
354 
355  bool SetValueArray(const std::vector<std::string> &values) override;
356  bool SetValue(const std::string &value) override;
357  std::string GetStrValue() const override;
358  std::string GetDefaultStrValue() const override;
359 
360  std::vector<std::string> GetValue() const { return m_values; }
361  std::vector<std::string> GetDefault() const { return m_defaultValues; }
362  bool SetValue(std::vector<std::string> const &values);
363 
364  void Reset() override;
365  bool IsSet() const override;
366 
367 private:
368  std::string GetStr(const std::vector<std::string> &values) const;
369 
370 public:
371  //
372 private:
373  std::vector<std::string> m_values;
374  std::vector<std::string> m_defaultValues;
375 };
376 
377 //----------------------------------------------------------------------------
378 // OptionIntMap
379 //----------------------------------------------------------------------------
380 
384 class OptionIntMap : public Option {
385 public:
386  // constructors and destructors
387  OptionIntMap();
388  virtual ~OptionIntMap() {}
389  void CopyTo(Option *option) override;
390  void Init(int defaultValue, const std::map<int, std::string> *values);
391 
392  bool SetValue(const std::string &value) override;
393  std::string GetStrValue() const override;
394  std::string GetDefaultStrValue() const override;
395 
396  int GetValue() const { return m_value; }
397  int GetDefault() const { return m_defaultValue; }
398  bool SetValue(int value);
399 
400  std::vector<std::string> GetStrValues(bool withoutDefault) const;
401  std::string GetStrValuesAsStr(bool withoutDefault) const;
402 
403  void Reset() override;
404  bool IsSet() const override;
405 
406 private:
407  //
408 public:
409  //
410 private:
411  const std::map<int, std::string> *m_values;
412  int m_value;
413  int m_defaultValue;
414 };
415 
416 //----------------------------------------------------------------------------
417 // OptionStaffrel
418 //----------------------------------------------------------------------------
419 
423 class OptionStaffrel : public Option {
424 public:
425  // constructors and destructors
426  OptionStaffrel() {}
427  virtual ~OptionStaffrel() {}
428  void CopyTo(Option *option) override;
429  // Alternate type style cannot have a restricted list of possible values
430  void Init(data_STAFFREL defaultValue);
431 
432  bool SetValue(const std::string &value) override;
433  std::string GetStrValue() const override;
434  std::string GetDefaultStrValue() const override;
435 
436  void Reset() override;
437  bool IsSet() const override;
438 
439  // For alternate types return a reference to the value
440  // Alternatively we can have a values vector for each sub-type
441  const data_STAFFREL *GetValueAlternate() const { return &m_value; }
442  const data_STAFFREL *GetDefaultAlernate() const { return &m_defaultValue; }
443 
444 private:
445  //
446 public:
447  //
448 private:
449  data_STAFFREL m_value;
450  data_STAFFREL m_defaultValue;
451 };
452 
453 //----------------------------------------------------------------------------
454 // OptionJson
455 //----------------------------------------------------------------------------
456 
458 enum class JsonSource { String, FilePath };
459 
464 class OptionJson : public Option {
465  using JsonPath = std::vector<std::reference_wrapper<jsonxx::Value>>;
466 
467 public:
472  OptionJson() = default;
473  virtual ~OptionJson() = default;
474  void CopyTo(Option *option) override;
475  void Init(JsonSource source, const std::string &defaultValue);
477 
481  JsonSource GetSource() const;
482  jsonxx::Object GetValue(bool getDefault = false) const;
483 
488  bool SetValue(const std::string &value) override;
489  std::string GetStrValue() const override;
490  std::string GetDefaultStrValue() const override;
491 
492  void Reset() override;
493  bool IsSet() const override;
495 
500  bool HasValue(const std::vector<std::string> &jsonNodePath) const;
501  int GetIntValue(const std::vector<std::string> &jsonNodePath, bool getDefault = false) const;
502  double GetDblValue(const std::vector<std::string> &jsonNodePath, bool getDefault = false) const;
503  std::string GetStrValue(const std::vector<std::string> &jsonNodePath, bool getDefault = false) const;
504  bool UpdateNodeValue(const std::vector<std::string> &jsonNodePath, const std::string &value);
506 
511  std::set<std::string> GetKeys() const;
512  std::set<std::string> GetKeysByNode(const std::string &nodeName, std::list<std::string> &jsonNodePath) const;
514 
515 protected:
516  JsonPath StringPath2NodePath(const jsonxx::Object &obj, const std::vector<std::string> &jsonNodePath) const;
517 
518  // Find node by recursively processing all elements within. Only nodes of OBJECT_ type are processed
519  const jsonxx::Object *FindNodeByName(
520  const jsonxx::Object &obj, const std::string &jsonNodeName, std::list<std::string> &jsonNodePath) const;
521 
523  bool ReadJson(jsonxx::Object &output, const std::string &input) const;
524 
525 private:
526  JsonSource m_source = JsonSource::String;
527 
528  jsonxx::Object m_values;
529  jsonxx::Object m_defaultValues;
530 };
531 
532 //----------------------------------------------------------------------------
533 // OptionGrp
534 //----------------------------------------------------------------------------
535 
539 class OptionGrp {
540 public:
541  // constructors and destructors
542  OptionGrp() {}
543  virtual ~OptionGrp() {}
544 
545  void SetLabel(const std::string &label, const std::string &id)
546  {
547  m_label = label;
548  m_id = id;
549  }
550  std::string GetLabel() const { return m_label; }
551  std::string GetId() const { return m_id; }
552 
553  void SetCategory(OptionsCategory category) { m_category = category; }
554  OptionsCategory GetCategory() const { return m_category; }
555 
556  void AddOption(Option *option) { m_options.push_back(option); }
557 
558  const std::vector<Option *> *GetOptions() const { return &m_options; }
559 
560 public:
561  //
562 protected:
563  std::string m_id;
564  std::string m_label;
565  std::vector<Option *> m_options;
566  OptionsCategory m_category = OptionsCategory::None;
567 };
568 
569 //----------------------------------------------------------------------------
570 // Options
571 //----------------------------------------------------------------------------
572 
576 class Options {
577 public:
578  // constructors and destructors
579  Options();
580  virtual ~Options();
581 
582  Options(const Options &options);
583  Options &operator=(const Options &options);
584 
585  const MapOfStrOptions *GetItems() const { return &m_items; }
586 
587  const std::vector<OptionGrp *> *GetGrps() const { return &m_grps; }
588 
589  jsonxx::Object GetBaseOptGrp();
590 
591  const std::vector<Option *> *GetBaseOptions() const;
592 
593  // post processing of parameters
594  void Sync();
595 
596 private:
597  void Register(Option *option, const std::string &key, OptionGrp *grp);
598 
599 public:
603  OptionGrp m_baseOptions;
604 
605  // These options are only given for documentation - except for m_scale
606  // They are ordered by short option alphabetical order
607  OptionBool m_standardOutput;
608  OptionString m_help;
609  OptionBool m_allPages;
610  OptionString m_inputFrom;
611  OptionString m_logLevel;
612  OptionString m_outfile;
613  OptionInt m_page;
614  OptionString m_resourcePath;
615  OptionInt m_scale;
616  OptionString m_outputTo;
617  OptionBool m_version;
618  OptionInt m_xmlIdSeed;
619 
623  OptionGrp m_general;
624 
625  OptionBool m_adjustPageHeight;
626  OptionBool m_adjustPageWidth;
627  OptionIntMap m_breaks;
628  OptionDbl m_breaksSmartSb;
629  OptionIntMap m_condense;
630  OptionBool m_condenseFirstPage;
631  OptionBool m_condenseNotLastSystem;
632  OptionBool m_condenseTempoPages;
633  OptionBool m_evenNoteSpacing;
634  OptionString m_expand;
635  OptionIntMap m_footer;
636  OptionIntMap m_header;
637  OptionBool m_humType;
638  OptionBool m_incip;
639  OptionBool m_justifyVertically;
640  OptionBool m_landscape;
641  OptionDbl m_minLastJustification;
642  OptionBool m_mmOutput;
643  OptionBool m_moveScoreDefinitionToStaff;
644  OptionBool m_neumeAsNote;
645  OptionBool m_noJustification;
646  OptionBool m_openControlEvents;
647  OptionBool m_outputFormatRaw;
648  OptionInt m_outputIndent;
649  OptionBool m_outputIndentTab;
650  OptionBool m_outputSmuflXmlEntities;
651  OptionInt m_pageHeight;
652  OptionInt m_pageMarginBottom;
653  OptionInt m_pageMarginLeft;
654  OptionInt m_pageMarginRight;
655  OptionInt m_pageMarginTop;
656  OptionInt m_pageWidth;
657  OptionIntMap m_pedalStyle;
658  OptionBool m_preserveAnalyticalMarkup;
659  OptionBool m_removeIds;
660  OptionBool m_scaleToPageSize;
661  OptionBool m_setLocale;
662  OptionBool m_showRuntime;
663  OptionBool m_shrinkToFit;
664  OptionIntMap m_smuflTextFont;
665  OptionBool m_staccatoCenter;
666  OptionBool m_svgBoundingBoxes;
667  OptionString m_svgCss;
668  OptionBool m_svgViewBox;
669  OptionBool m_svgHtml5;
670  OptionBool m_svgFormatRaw;
671  OptionBool m_svgRemoveXlink;
672  OptionArray m_svgAdditionalAttribute;
673  OptionDbl m_unit;
674  OptionBool m_useFacsimile;
675  OptionBool m_usePgFooterForAll;
676  OptionBool m_usePgHeaderForAll;
677  OptionBool m_useBraceGlyph;
678  OptionBool m_xmlIdChecksum;
679 
683  OptionGrp m_generalLayout;
684 
685  OptionDbl m_barLineSeparation;
686  OptionDbl m_barLineWidth;
687  OptionBool m_beamFrenchStyle;
688  OptionInt m_beamMaxSlope;
689  OptionBool m_beamMixedPreserve;
690  OptionDbl m_beamMixedStemMin;
691  OptionDbl m_bracketThickness;
692  OptionBool m_breaksNoWidow;
693  OptionDbl m_dashedBarLineDashLength;
694  OptionDbl m_dashedBarLineGapLength;
695  OptionDbl m_dynamDist;
696  OptionBool m_dynamSingleGlyphs;
697  OptionJson m_engravingDefaults;
698  OptionJson m_engravingDefaultsFile;
699  OptionDbl m_extenderLineMinSpace;
700  OptionDbl m_fingeringScale;
701  OptionString m_font;
702  OptionArray m_fontAddCustom;
703  OptionIntMap m_fontFallback;
704  OptionBool m_fontLoadAll;
705  OptionBool m_fontTextLiberation;
706  OptionDbl m_graceFactor;
707  OptionBool m_graceRhythmAlign;
708  OptionBool m_graceRightAlign;
709  OptionDbl m_hairpinSize;
710  OptionDbl m_hairpinThickness;
711  OptionArray m_handwrittenFont;
712  OptionDbl m_harmDist;
713  OptionDbl m_justificationBraceGroup;
714  OptionDbl m_justificationBracketGroup;
715  OptionDbl m_justificationStaff;
716  OptionDbl m_justificationSystem;
717  OptionDbl m_justificationMaxVertical;
718  OptionDbl m_ledgerLineThickness;
719  OptionDbl m_ledgerLineExtension;
720  OptionIntMap m_lyricElision;
721  OptionDbl m_lyricHeightFactor;
722  OptionDbl m_lyricLineThickness;
723  OptionBool m_lyricNoStartHyphen;
724  OptionDbl m_lyricSize;
725  OptionDbl m_lyricTopMinMargin;
726  OptionBool m_lyricVerseCollapse;
727  OptionDbl m_lyricWordSpace;
728  OptionInt m_measureMinWidth;
729  OptionInt m_mnumInterval;
730  OptionIntMap m_multiRestStyle;
731  OptionDbl m_multiRestThickness;
732  OptionBool m_octaveAlternativeSymbols;
733  OptionDbl m_octaveLineThickness;
734  OptionBool m_octaveNoSpanningParentheses;
735  OptionDbl m_pedalLineThickness;
736  OptionDbl m_repeatBarLineDotSeparation;
737  OptionDbl m_repeatEndingLineThickness;
738  OptionDbl m_slurCurveFactor;
739  OptionDbl m_slurEndpointFlexibility;
740  OptionDbl m_slurEndpointThickness;
741  OptionDbl m_slurMargin;
742  OptionInt m_slurMaxSlope;
743  OptionDbl m_slurMidpointThickness;
744  OptionDbl m_slurSymmetry;
745  OptionInt m_spacingBraceGroup;
746  OptionInt m_spacingBracketGroup;
747  OptionBool m_spacingDurDetection;
748  OptionDbl m_spacingLinear;
749  OptionDbl m_spacingNonLinear;
750  OptionInt m_spacingStaff;
751  OptionInt m_spacingSystem;
752  OptionDbl m_staffLineWidth;
753  OptionDbl m_stemWidth;
754  OptionDbl m_subBracketThickness;
755  OptionIntMap m_systemDivider;
756  OptionInt m_systemMaxPerPage;
757  OptionDbl m_textEnclosureThickness;
758  OptionDbl m_thickBarlineThickness;
759  OptionDbl m_tieEndpointThickness;
760  OptionDbl m_tieMidpointThickness;
761  OptionDbl m_tieMinLength;
762  OptionBool m_tupletAngledOnBeams;
763  OptionDbl m_tupletBracketThickness;
764  OptionBool m_tupletNumHead;
765 
769  OptionGrp m_selectors;
770 
771  OptionArray m_appXPathQuery;
772  OptionArray m_choiceXPathQuery;
773  OptionBool m_loadSelectedMdivOnly;
774  OptionBool m_mdivAll;
775  OptionString m_mdivXPathQuery;
776  OptionArray m_substXPathQuery;
777  OptionString m_transpose;
778  OptionJson m_transposeMdiv;
779  OptionBool m_transposeSelectedOnly;
780  OptionBool m_transposeToSoundingPitch;
781 
785  OptionGrp m_elementMargins;
786 
787  OptionDbl m_defaultBottomMargin;
788  OptionDbl m_defaultLeftMargin;
789  OptionDbl m_defaultRightMargin;
790  OptionDbl m_defaultTopMargin;
791  //
792  OptionDbl m_bottomMarginArtic;
793  OptionDbl m_bottomMarginHarm;
794  OptionDbl m_bottomMarginOctave;
795  OptionDbl m_bottomMarginPgHead;
796  //
797  OptionDbl m_leftMarginAccid;
798  OptionDbl m_leftMarginBarLine;
799  OptionDbl m_leftMarginBeatRpt;
800  OptionDbl m_leftMarginChord;
801  OptionDbl m_leftMarginClef;
802  OptionDbl m_leftMarginKeySig;
803  OptionDbl m_leftMarginLeftBarLine;
804  OptionDbl m_leftMarginMensur;
805  OptionDbl m_leftMarginMeterSig;
806  OptionDbl m_leftMarginMRest;
807  OptionDbl m_leftMarginMRpt2;
808  OptionDbl m_leftMarginMultiRest;
809  OptionDbl m_leftMarginMultiRpt;
810  OptionDbl m_leftMarginNote;
811  OptionDbl m_leftMarginRest;
812  OptionDbl m_leftMarginRightBarLine;
813  OptionDbl m_leftMarginTabDurSym;
814  //
815  OptionDbl m_rightMarginAccid;
816  OptionDbl m_rightMarginBarLine;
817  OptionDbl m_rightMarginBeatRpt;
818  OptionDbl m_rightMarginChord;
819  OptionDbl m_rightMarginClef;
820  OptionDbl m_rightMarginKeySig;
821  OptionDbl m_rightMarginLeftBarLine;
822  OptionDbl m_rightMarginMensur;
823  OptionDbl m_rightMarginMeterSig;
824  OptionDbl m_rightMarginMRest;
825  OptionDbl m_rightMarginMRpt2;
826  OptionDbl m_rightMarginMultiRest;
827  OptionDbl m_rightMarginMultiRpt;
828  OptionDbl m_rightMarginNote;
829  OptionDbl m_rightMarginRest;
830  OptionDbl m_rightMarginRightBarLine;
831  OptionDbl m_rightMarginTabDurSym;
832  //
833  OptionDbl m_topMarginArtic;
834  OptionDbl m_topMarginHarm;
835  OptionDbl m_topMarginPgFooter;
836 
840  OptionGrp m_midi;
841 
842  OptionBool m_midiNoCue;
843  OptionDbl m_midiTempoAdjustment;
844 
848  OptionGrp m_mensural;
849 
850  OptionIntMap m_durationEquivalence;
851  OptionBool m_ligatureAsBracket;
852  OptionIntMap m_ligatureOblique;
853  OptionBool m_mensuralScoreUp;
854  OptionBool m_mensuralResponsiveView;
855  OptionBool m_mensuralToCmn;
856 
860  OptionGrp m_jsonCmdLineOptions;
861 
862  OptionString m_timemapOptions;
863 
867  OptionGrp m_deprecated;
868 
869 private:
871  MapOfStrOptions m_items;
872 
873  std::vector<OptionGrp *> m_grps;
874 };
875 
876 } // namespace vrv
877 
878 #endif // CUSTOM_VEROVIO_OPTIONS
879 
880 #endif // __VRV_DEF_H__
vrv::OptionArray
This class is for array (string) styling params.
Definition: options.h:347
vrv::OptionBool
This class is for boolean styling params.
Definition: options.h:178
vrv::OptionDbl
This class is for integer styling params.
Definition: options.h:217
vrv::OptionGrp
This class is a base class of each styling parameter.
Definition: options.h:539
vrv::Option
This class is a base class of each styling parameter.
Definition: options.h:100
vrv::Option::s_breaks
static const std::map< int, std::string > s_breaks
Static maps used my OptionIntMap objects.
Definition: options.h:146
vrv::Option::ToJson
jsonxx::Object ToJson() const
Return a JSON object for the option.
vrv::OptionInt
This class is for integer styling params.
Definition: options.h:265
vrv::OptionIntMap
This class is for map break options.
Definition: options.h:384
vrv::OptionJson
This class is for Json input params.
Definition: options.h:464
vrv::OptionJson::GetKeys
std::set< std::string > GetKeys() const
Accessing all keys.
vrv::OptionJson::ReadJson
bool ReadJson(jsonxx::Object &output, const std::string &input) const
Read json from string or file.
vrv::OptionJson::GetSource
JsonSource GetSource() const
Member access.
vrv::OptionJson::HasValue
bool HasValue(const std::vector< std::string > &jsonNodePath) const
Accessing values as json node path.
vrv::OptionJson::SetValue
bool SetValue(const std::string &value) override
Interface methods: accessing values as string.
vrv::OptionStaffrel
This class is for map styling params.
Definition: options.h:423
vrv::OptionString
This class is for string styling params.
Definition: options.h:313
vrv::Options
This class contains the document styling parameters.
Definition: options.h:576
vrv::Options::m_generalLayout
OptionGrp m_generalLayout
General layout.
Definition: options.h:683
vrv::Options::m_baseOptions
OptionGrp m_baseOptions
Comments in implementation file options.cpp.
Definition: options.h:603
vrv::Options::m_general
OptionGrp m_general
General.
Definition: options.h:623
vrv::Options::m_midi
OptionGrp m_midi
Midi.
Definition: options.h:840
vrv::Options::m_elementMargins
OptionGrp m_elementMargins
Element margins.
Definition: options.h:785
vrv::Options::m_deprecated
OptionGrp m_deprecated
Deprecated options.
Definition: options.h:867
vrv::Options::m_mensural
OptionGrp m_mensural
Mensural.
Definition: options.h:848
vrv::Options::m_jsonCmdLineOptions
OptionGrp m_jsonCmdLineOptions
Additional options for passing method JSON options to the command-line.
Definition: options.h:860
vrv::Options::m_selectors
OptionGrp m_selectors
Selectors.
Definition: options.h:769