MuseScore/libmscore/mscore.h
Joachim Schmitz b60ba76d75 fix #305613: add heavy, reverse end and heavy double barlines
Use translated names of barlines in timeline.
Change to use SMuFL names for barlines so we use the same strings and
translations in basic and advanced workspace palettes, master symbols
palette (untranslated before), inspector and timeline.

Previous versions won't show them and also loose them on save
2020-06-05 13:26:53 +02:00

417 lines
13 KiB
C++

//=============================================================================
// MuseScore
// Music Composition & Notation
//
// Copyright (C) 2011-2013 Werner Schweer and others
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License version 2
// as published by the Free Software Foundation and appearing in
// the file LICENSE.GPL
//=============================================================================
#ifndef __MSCORE_H__
#define __MSCORE_H__
#include "config.h"
#include "style.h"
namespace Ms {
#define MSC_VERSION "3.01"
static constexpr int MSCVERSION = 301;
// History:
// 1.3 added staff->_barLineSpan
// 1.4 (Version 0.9)
// 1.5 save xoff/yoff in mm instead of pixel
// 1.6 save harmony base/root as tpc value
// 1.7 invert semantic of page fill limit
// 1.8 slur id, slur anchor in in Note
// 1.9 image size stored in mm instead of pixel (Versions 0.9.2 -0.9.3)
// 1.10 TextLine properties changed (Version 0.9.4)
// 1.11 Instrument name in part saved as TextC (Version 0.9.5)
// 1.12 use durationType, remove tickLen
// 1.13 Clefs: userOffset is not (mis)used for vertical layout position
// 1.14 save user modified beam position as spatium value (Versions 0.9.6 - 1.3)
// 1.15 save timesig inline; Lyrics "endTick" replaced by "ticks"
// 1.16 spanners (hairpin, trill etc.) are now inline and have no ticks anymore
// 1.17 new <Score> toplevel structure to support linked parts (excerpts)
// 1.18 save lyrics as subtype to chord/rest to allow them associated with
// grace notes
// 1.19 replace text style numbers by text style names; box margins are now
// used
// 1.20 instrument names are saved as html again
// 1.21 no cleflist anymore
// 1.22 timesig changed
// 1.23 measure property for actual length
// 1.24 default image size is spatium dependent
// - symbol numbers in TextLine() replaced by symbol names
// TextStyle: frameWidth, paddingWidth are now in Spatium units (instead of mm)
// 2.00 (Version 2.0)
// 2.01 save SlurSegment position relative to staff
// 2.02 save instrumentId, note slashes
// 2.03 save Box topGap, bottomGap in spatium units
// 2.04 added hideSystemBarLine flag to Staff
// 2.05 breath segment changed to use tick of following chord rather than preceding chord
// 2.06 Glissando moved from final chord to start note (Version 2.0.x)
//
// 2.07 irregular, breakMMrest, more style options, system divider, bass string for tab (3.0)
// 3.00 (Version 3.0 alpha)
class MStyle;
class Sequencer;
enum class HairpinType : signed char;
#ifndef VOICES
#define VOICES 4
#endif
inline int staff2track(int staffIdx) { return staffIdx << 2; }
inline int track2staff(int voice) { return voice >> 2; }
inline int track2voice(int track) { return track & 3; }
inline int trackZeroVoice(int track) { return track & ~3; }
static const int MAX_TAGS = 32;
static const int MAX_HEADERS = 3;
static const int MAX_FOOTERS = 3;
static constexpr qreal INCH = 25.4;
static constexpr qreal PPI = 72.0; // printer points per inch
static constexpr qreal DPI_F = 5;
static constexpr qreal DPI = 72.0 * DPI_F;
static constexpr qreal SPATIUM20 = 5.0 * (DPI / 72.0);
static constexpr qreal DPMM = DPI / INCH;
static constexpr int MAX_STAVES = 4;
static const int SHADOW_NOTE_LIGHT = 135;
static const char mimeSymbolFormat[] = "application/musescore/symbol";
static const char mimeSymbolListFormat[] = "application/musescore/symbollist";
static const char mimeStaffListFormat[] = "application/musescore/stafflist";
static const int VISUAL_STRING_NONE = -100; // no ordinal for the visual repres. of string (topmost in TAB
// varies according to visual order and presence of bass strings)
static const int STRING_NONE = -1; // no ordinal for a physical string (0 = topmost in instrument)
static const int FRET_NONE = -1; // no ordinal for a fret
//---------------------------------------------------------
// BracketType
// System Brackets
//---------------------------------------------------------
enum class BracketType : signed char {
NORMAL, BRACE, SQUARE, LINE, NO_BRACKET = -1
};
//---------------------------------------------------------
// PlaceText
//---------------------------------------------------------
enum class PlaceText : char {
AUTO, ABOVE, BELOW, LEFT
};
//---------------------------------------------------------
// TransposeDirection
//---------------------------------------------------------
enum class TransposeDirection : char {
UP, DOWN, CLOSEST
};
//---------------------------------------------------------
// TransposeMode
//---------------------------------------------------------
enum class TransposeMode : char {
TO_KEY, BY_INTERVAL, DIATONICALLY
};
//---------------------------------------------------------
// SelectType
//---------------------------------------------------------
enum class SelectType : char {
SINGLE, RANGE, ADD
};
//---------------------------------------------------------
// AccidentalVal
//---------------------------------------------------------
enum class AccidentalVal : signed char {
SHARP2 = 2,
SHARP = 1,
NATURAL = 0,
FLAT = -1,
FLAT2 = -2
};
//---------------------------------------------------------
// KeySigNaturals (positions of naturals in key sig. changes)
//---------------------------------------------------------
enum class KeySigNatural : char {
NONE = 0, // no naturals, except for change to CMaj/Amin
BEFORE = 1, // naturals before accidentals
AFTER = 2 // naturals after accidentals (but always before if going sharps <=> flats)
};
//---------------------------------------------------------
// UpDownMode
//---------------------------------------------------------
enum class UpDownMode : char {
CHROMATIC, OCTAVE, DIATONIC
};
//---------------------------------------------------------
// StaffGroup
//---------------------------------------------------------
enum class StaffGroup : char {
STANDARD, PERCUSSION, TAB
};
const int STAFF_GROUP_MAX = int(StaffGroup::TAB) + 1; // out of enum to avoid compiler complains about not handled switch cases
//---------------------------------------------------------
// BarLineType
//---------------------------------------------------------
enum class BarLineType {
NORMAL = 1,
SINGLE = BarLineType::NORMAL,
DOUBLE = 2,
START_REPEAT = 4,
LEFT_REPEAT = BarLineType::START_REPEAT,
END_REPEAT = 8,
RIGHT_REPEAT = BarLineType::END_REPEAT,
BROKEN = 0x10,
DASHED = BarLineType::BROKEN,
END = 0x20,
FINAL = BarLineType::END,
END_START_REPEAT = 0x40,
LEFT_RIGHT_REPEAT= BarLineType::END_START_REPEAT,
DOTTED = 0x80,
REVERSE_END = 0x100,
REVERSE_FINALE = BarLineType::REVERSE_END,
HEAVY = 0x200,
DOUBLE_HEAVY = 0x400,
};
constexpr BarLineType operator|(BarLineType t1, BarLineType t2)
{
return static_cast<BarLineType>(static_cast<int>(t1) | static_cast<int>(t2));
}
constexpr bool operator&(BarLineType t1, BarLineType t2)
{
return static_cast<int>(t1) & static_cast<int>(t2);
}
// Icon() subtypes
enum class IconType : signed char {
NONE = -1,
ACCIACCATURA, APPOGGIATURA, GRACE4, GRACE16, GRACE32,
GRACE8_AFTER, GRACE16_AFTER, GRACE32_AFTER,
SBEAM, MBEAM, NBEAM, BEAM32, BEAM64, AUTOBEAM,
FBEAM1, FBEAM2,
VFRAME, HFRAME, TFRAME, FFRAME, MEASURE,
BRACKETS, PARENTHESES
};
//---------------------------------------------------------
// MScoreError
//---------------------------------------------------------
enum MsError {
MS_NO_ERROR,
NO_NOTE_SELECTED,
NO_CHORD_REST_SELECTED,
NO_LYRICS_SELECTED,
NO_NOTE_REST_SELECTED,
NO_FLIPPABLE_SELECTED,
NO_STAFF_SELECTED,
NO_NOTE_FIGUREDBASS_SELECTED,
CANNOT_INSERT_TUPLET,
CANNOT_SPLIT_TUPLET,
CANNOT_SPLIT_MEASURE_FIRST_BEAT,
CANNOT_SPLIT_MEASURE_TUPLET,
NO_DEST,
DEST_TUPLET,
TUPLET_CROSSES_BAR,
DEST_LOCAL_TIME_SIGNATURE,
DEST_TREMOLO,
NO_MIME,
DEST_NO_CR,
CANNOT_CHANGE_LOCAL_TIMESIG,
};
/// \cond PLUGIN_API \private \endcond
struct MScoreError {
MsError no;
const char* group;
const char* txt;
};
//---------------------------------------------------------
// MPaintDevice
/// \cond PLUGIN_API \private \endcond
//---------------------------------------------------------
class MPaintDevice : public QPaintDevice
{
protected:
virtual int metric(PaintDeviceMetric m) const;
public:
MPaintDevice()
: QPaintDevice() {}
virtual QPaintEngine* paintEngine() const;
virtual ~MPaintDevice() {}
};
//---------------------------------------------------------
// MScore
// MuseScore application object
//---------------------------------------------------------
class MScore
{
Q_GADGET
static MStyle _baseStyle; // buildin initial style
static MStyle _defaultStyle; // buildin modified by preferences
static MStyle* _defaultStyleForParts;
static QString _globalShare;
static int _hRaster, _vRaster;
static bool _verticalOrientation;
static MPaintDevice* _paintDevice;
public:
enum class DirectionH : char { /**.\{*/
AUTO, LEFT, RIGHT /**\}*/
};
enum class OrnamentStyle : char { /**.\{*/
DEFAULT, BAROQUE /**\}*/
};
Q_ENUM(DirectionH);
Q_ENUM(OrnamentStyle);
static MsError _error;
static std::vector<MScoreError> errorList;
static void init();
static const MStyle& baseStyle() { return _baseStyle; }
static MStyle& defaultStyle() { return _defaultStyle; }
static const MStyle* defaultStyleForParts() { return _defaultStyleForParts; }
static bool readDefaultStyle(QString file);
static void setDefaultStyle(const MStyle& s) { _defaultStyle = s; }
static void defaultStyleForPartsHasChanged();
static const QString& globalShare() { return _globalShare; }
static qreal hRaster() { return _hRaster; }
static qreal vRaster() { return _vRaster; }
static void setHRaster(int val) { _hRaster = val; }
static void setVRaster(int val) { _vRaster = val; }
static void setNudgeStep(qreal val) { nudgeStep = val; }
static void setNudgeStep10(qreal val) { nudgeStep10 = val; }
static void setNudgeStep50(qreal val) { nudgeStep50 = val; }
static bool verticalOrientation() { return _verticalOrientation; }
static void setVerticalOrientation(bool val) { _verticalOrientation = val; }
static QColor selectColor[VOICES];
static QColor defaultColor;
static QColor dropColor;
static QColor layoutBreakColor;
static QColor frameMarginColor;
static QColor bgColor;
static bool warnPitchRange;
static int pedalEventsMinTicks;
static bool playRepeats;
static bool panPlayback;
static qreal nudgeStep;
static qreal nudgeStep10;
static qreal nudgeStep50;
static int defaultPlayDuration;
static QString lastError;
// #ifndef NDEBUG
static bool noHorizontalStretch;
static bool noVerticalStretch;
static bool showSegmentShapes;
static bool showSkylines;
static bool showMeasureShapes;
static bool showBoundingRect;
static bool showSystemBoundingRect;
static bool showCorruptedMeasures;
static bool useFallbackFont;
// #endif
static bool debugMode;
static bool testMode;
static int division;
static int sampleRate;
static int mtcType;
static Sequencer* seq;
static bool saveTemplateMode;
static bool noGui;
static bool noExcerpts;
static bool noImages;
static bool pdfPrinting;
static bool svgPrinting;
static double pixelRatio;
static qreal verticalPageGap;
static qreal horizontalPageGapEven;
static qreal horizontalPageGapOdd;
static MPaintDevice* paintDevice();
static void setError(MsError e) { _error = e; }
static const char* errorMessage();
static const char* errorGroup();
};
//---------------------------------------------------------
// center
//---------------------------------------------------------
inline static qreal center(qreal x1, qreal x2)
{
return x1 + (x2 - x1) * .5;
}
//---------------------------------------------------------
// limit
//---------------------------------------------------------
inline static int limit(int val, int min, int max)
{
if (val > max) {
return max;
}
if (val < min) {
return min;
}
return val;
}
} // namespace Ms
Q_DECLARE_METATYPE(Ms::BarLineType);
#endif