Fundamentals.h

/*
 * Copyright (C) 2025, Robert Patterson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once
 
#include <cstdint>
 
#if defined(_WIN32)
#define MUSX_RUNNING_ON_WINDOWS
#elif defined(__APPLE__) && defined(__MACH__)
#define MUSX_RUNNING_ON_MACOS
#elif defined(__unix__) || defined(__linux__)
#define MUSX_RUNNING_ON_LINUX_UNIX
#else
#error "Unable to detect operating system platform."
#endif
 
#ifdef MUSX_THROW_ON_INTEGRITY_CHECK_FAIL
#define MUSX_INTEGRITY_ERROR(S) throw ::musx::dom::integrity_error(S)
#else
#define MUSX_INTEGRITY_ERROR(S) ::musx::util::Logger::log(::musx::util::Logger::LogLevel::Warning, (S))
#endif
 
#ifdef MUSX_THROW_ON_UNKNOWN_XML
#define MUSX_UNKNOWN_XML(S) throw ::musx::factory::unknown_xml_error(S)
#else
#define MUSX_UNKNOWN_XML(S) ::musx::util::Logger::log(::musx::util::Logger::LogLevel::Warning, (S))
#endif
 
#define MUSX_ASSERT_IF(TEST) \
assert(!(TEST)); \
if (TEST)
 
namespace musx {
namespace dom {
 
using Cmper = uint16_t;             
using Inci = int16_t;               
using Evpu = int32_t;               
using EvpuFloat = double;           
using Evpu16ths = int32_t;          
using Efix = int32_t;               
using Edu = int32_t;                
using EduFloat = double;            
 
using MeasCmper = int16_t;          
using StaffCmper = int16_t;         
using SystemCmper = int16_t;        
using PageCmper = int16_t;          
using ClefIndex = uint16_t;         
using EntryNumber = int32_t;        
using NoteNumber = uint16_t;        
using LayerIndex = unsigned int;    
using BeamNumber = unsigned int;    
using PercussionNoteTypeId = uint16_t; 
 
constexpr Cmper MUSX_GLOBALS_CMPER = 65534; 
constexpr int MAX_LAYERS = 4;       
constexpr int MAX_ALTERATIONS = 7;  
constexpr Cmper SCORE_PARTID = 0;   
 
constexpr double EVPU_PER_INCH = 288.0;         
constexpr double EVPU_PER_POINT = 4.0;          
constexpr double EVPU_PER_MM = EVPU_PER_INCH / 25.4; 
constexpr double EVPU_PER_CM = EVPU_PER_MM * 10.0;   
constexpr double EVPU_PER_PX = EVPU_PER_INCH / 96.0; 
constexpr double EVPU_PER_PICA = EVPU_PER_POINT * 12.0; 
constexpr double EVPU_PER_SPACE = 24.0;         
constexpr double EFIX_PER_EVPU = 64.0;          
constexpr double EFIX_PER_SPACE = EVPU_PER_SPACE * EFIX_PER_EVPU; 
constexpr Edu EDU_PER_WHOLE_NOTE = 0x1000;    
 
constexpr Cmper BASE_SYSTEM_ID = 0; 
constexpr Cmper STAFF_SET_1_SYSTEM_ID = 65500;  
constexpr Cmper STUDIO_VIEW_SYSTEM_ID = 65400;  
constexpr Cmper SPECIAL_PART_EXTRACTION_SYSTEM_ID = 65528;  
constexpr Cmper TEMP_SYSTEM_ID = 65529;     
 
constexpr int MAX_CUE_PERCENTAGE = 90; 
 
namespace smulf_glyph {
// Use namespace instead of enum class due to comparison ugliness with enum class.
constexpr char32_t unpitchedPercussionClef2 = 0xE06A;   
constexpr char32_t timeSigCommon = 0xE08A;              
constexpr char32_t timeSigCutCommon = 0xE08B;           
constexpr char32_t sixStringTabClefSerif = 0xF40B;      
constexpr char32_t fourStringTabClefSerif = 0xF40D;     
} //namespace smulf_glyph
 
namespace symbol_glyph {
// Use namespace instead of enum class due to comparison ugliness with enum class.
constexpr char32_t unpitchedPercussionClef2 = 214;   
} //namespace symbol_glyph
 
} // namespace dom
} // namespace musx