source/utils/CarlaStateUtils.hpp

   1 /*
   2  * Carla State utils
   3  * Copyright (C) 2012-2023 Filipe Coelho <falktx@falktx.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of
   8  * the License, or any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * For a full copy of the GNU General Public License see the doc/GPL.txt file.
  16  */
  17
  18 #ifndef CARLA_STATE_UTILS_HPP_INCLUDED
  19 #define CARLA_STATE_UTILS_HPP_INCLUDED
  20
  21 #include "CarlaBackend.h"
  22 #include "LinkedList.hpp"
  23
  24 #include "water/text/String.h"
  25
  26 CARLA_BACKEND_START_NAMESPACE
  27
  28 // -----------------------------------------------------------------------
  29
  30 struct CarlaStateSave {
  31     struct Parameter {
  32         bool        dummy; // if true only midiChannel/CC are used
  33         int32_t     index;
  34         const char* name;
  35         const char* symbol;
  36         float       value;
  37        #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  38         int16_t mappedControlIndex;
  39         uint8_t midiChannel;
  40         bool    mappedRangeValid;
  41         float   mappedMinimum;
  42         float   mappedMaximum;
  43        #endif
  44
  45         Parameter() noexcept;
  46         ~Parameter() noexcept;
  47
  48         CARLA_DECLARE_NON_COPYABLE(Parameter)
  49     };
  50
  51     typedef LinkedList<Parameter*> ParameterList;
  52     typedef LinkedList<Parameter*>::Itenerator ParameterItenerator;
  53
  54     struct CustomData {
  55         const char* type;
  56         const char* key;
  57         const char* value;
  58
  59         CustomData() noexcept;
  60         ~CustomData() noexcept;
  61         bool isValid() const noexcept;
  62
  63         CARLA_DECLARE_NON_COPYABLE(CustomData)
  64     };
  65
  66     typedef LinkedList<CustomData*> CustomDataList;
  67     typedef LinkedList<CustomData*>::Itenerator CustomDataItenerator;
  68
  69     const char* type;
  70     const char* name;
  71     const char* label;
  72     const char* binary;
  73     int64_t     uniqueId;
  74     uint        options;
  75
  76     // saved during clone, rename or similar
  77     bool temporary;
  78
  79    #ifndef BUILD_BRIDGE_ALTERNATIVE_ARCH
  80     bool   active;
  81     float  dryWet;
  82     float  volume;
  83     float  balanceLeft;
  84     float  balanceRight;
  85     float  panning;
  86     int8_t ctrlChannel;
  87    #endif
  88
  89     int32_t     currentProgramIndex;
  90     const char* currentProgramName;
  91     int32_t     currentMidiBank;
  92     int32_t     currentMidiProgram;
  93     const char* chunk;
  94
  95     ParameterList parameters;
  96     CustomDataList customData;
  97
  98     CarlaStateSave() noexcept;
  99     ~CarlaStateSave() noexcept;
 100     void clear() noexcept;
 101
 102     bool fillFromXmlElement(const water::XmlElement* const xmlElement);
 103     void dumpToMemoryStream(water::MemoryOutputStream& stream) const;
 104
 105     CARLA_DECLARE_NON_COPYABLE(CarlaStateSave)
 106 };
 107
 108 static inline
 109 water::String xmlSafeString(const char* const cstring, const bool toXml)
 110 {
 111     water::String newString = water::String(water::CharPointer_UTF8(cstring));
 112
 113     if (toXml)
 114         return newString.replace("&","&amp;").replace("<","&lt;").replace(">","&gt;").replace("'","&apos;").replace("\"","&quot;");
 115     else
 116         return newString.replace("&lt;","<").replace("&gt;",">").replace("&apos;","'").replace("&quot;","\"").replace("&amp;","&");
 117 }
 118
 119 static inline
 120 water::String xmlSafeString(const water::String& string, const bool toXml)
 121 {
 122     water::String newString(string);
 123
 124     if (toXml)
 125         return newString.replace("&","&amp;").replace("<","&lt;").replace(">","&gt;").replace("'","&apos;").replace("\"","&quot;");
 126     else
 127         return newString.replace("&lt;","<").replace("&gt;",">").replace("&apos;","'").replace("&quot;","\"").replace("&amp;","&");
 128 }
 129
 130 // -----------------------------------------------------------------------
 131
 132 CARLA_BACKEND_END_NAMESPACE
 133
 134 #endif // CARLA_STATE_UTILS_HPP_INCLUDED