diff --git a/VST3_SDK/CMakeLists.txt b/VST3_SDK/CMakeLists.txt new file mode 100644 index 0000000000..0ede9b4261 --- /dev/null +++ b/VST3_SDK/CMakeLists.txt @@ -0,0 +1,220 @@ + +cmake_minimum_required (VERSION 3.4.3) + +#------------------------------------------------------------------------------- +# Includes +#------------------------------------------------------------------------------- + +list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules") + +include(Global) +include(AddVST3Library) +include(Bundle) +include(ExportedSymbols) +include(PrefixHeader) +include(PlatformIOS) + +# do not build VST2 by default +option(SMTG_CREATE_VST2_VERSION "Use VST2" OFF) + +#------------------------------------------------------------------------------- +# SDK Project +#------------------------------------------------------------------------------- +set(VST_SDK TRUE) +project(vstsdk) + +if (LINUX) + option(SMTG_ADD_ADDRESS_SANITIZER_CONFIG "Add AddressSanitizer Config (Linux only)" OFF) + if(SMTG_ADD_ADDRESS_SANITIZER_CONFIG) + set(CMAKE_CONFIGURATION_TYPES "${CMAKE_CONFIGURATION_TYPES};ASan") + add_compile_options($<$:-DDEVELOPMENT=1>) + add_compile_options($<$:-fsanitize=address>) + add_compile_options($<$:-DVSTGUI_LIVE_EDITING=1>) + add_compile_options($<$:-g>) + add_compile_options($<$:-O0>) + set(ASAN_LIBRARY asan) + link_libraries($<$:${ASAN_LIBRARY}>) + endif() +endif() + +if(UNIX) + if(XCODE) + set(CMAKE_XCODE_ATTRIBUTE_CLANG_CXX_LANGUAGE_STANDARD "c++14") + set(CMAKE_XCODE_ATTRIBUTE_CLANG_CXX_LIBRARY "libc++") + elseif(APPLE) + set(CMAKE_POSITION_INDEPENDENT_CODE TRUE) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14 -stdlib=libc++") + link_libraries(c++) + else() + set(CMAKE_POSITION_INDEPENDENT_CODE TRUE) + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14 -Wno-multichar") + link_libraries(stdc++fs pthread dl) + endif() + +elseif(WIN) + add_definitions(-D_UNICODE) + add_compile_options(/fp:fast) + add_compile_options($<$:/Oi>) # Enable Intrinsic Functions (Yes) + add_compile_options($<$:/Ot>) # Favor Size Or Speed (Favor fast code) + #add_compile_options($<$:/Ox>) # Optimization (/O2: Maximise Speed /0x: Full Optimization) + add_compile_options($<$:/GF>) # Enable String Pooling + add_compile_options($<$:/EHa>) # Enable C++ Exceptions + add_compile_options($<$:/Oy>) # Omit Frame Pointers +endif() + +set(ROOT "${CMAKE_CURRENT_SOURCE_DIR}") + +# here you can define where the VST3 SDK is located +set(SDK_ROOT "${ROOT}") + +# here you can define where the VSTGUI is located +set(VSTGUI_ROOT "${ROOT}") + +include_directories(${ROOT} ${SDK_ROOT}) + +set(SDK_IDE_LIBS_FOLDER FOLDER "Libraries") +set(SDK_IDE_PLUGIN_EXAMPLES_FOLDER FOLDER "PlugInExamples") +set(SDK_IDE_HOSTING_EXAMPLES_FOLDER FOLDER "HostingExamples") + +#------------------------------------------------------------------------------- +if(MAC AND XCODE) + if(NOT SMTG_COREAUDIO_SDK_PATH) + # Check if the CoreAudio SDK is next to the VST3SDK: + if(EXISTS "${SDK_ROOT}/../CoreAudio/AudioUnits/AUPublic/AUBase/AUBase.cpp") + set(SMTG_COREAUDIO_SDK_PATH "${SDK_ROOT}/../CoreAudio") + else() + if(EXISTS "${SDK_ROOT}/external.apple.coreaudio/AudioUnits/AUPublic/AUBase/AUBase.cpp") + set(SMTG_COREAUDIO_SDK_PATH "${SDK_ROOT}/external.apple.coreaudio") + endif() + endif() + else() + if(NOT IS_ABSOLUTE ${SMTG_COREAUDIO_SDK_PATH}) + get_filename_component(SMTG_COREAUDIO_SDK_PATH "${SDK_ROOT}/${SMTG_COREAUDIO_SDK_PATH}" ABSOLUTE) + endif() + if(NOT EXISTS "${SMTG_COREAUDIO_SDK_PATH}/AudioUnits/AUPublic/AUBase/AUBase.cpp") + message(FATAL_ERROR "SMTG_COREAUDIO_SDK_PATH is set but does not point to an expected location") + endif() + endif() + if(SMTG_COREAUDIO_SDK_PATH) + message(STATUS "SMTG_COREAUDIO_SDK_PATH is set to : " ${SMTG_COREAUDIO_SDK_PATH}) + endif() +endif() + +#------------------------------------------------------------------------------- +# Projects +#------------------------------------------------------------------------------- + +add_subdirectory(base) +add_subdirectory(public.sdk) +add_subdirectory(public.sdk/source/vst/auwrapper) +add_subdirectory(public.sdk/source/vst/auwrapper/again) +add_subdirectory(public.sdk/source/vst/interappaudio) +add_subdirectory(public.sdk/samples/vst/again) +add_subdirectory(public.sdk/samples/vst/adelay) +add_subdirectory(public.sdk/samples/vst/channelcontext) +add_subdirectory(public.sdk/samples/vst/hostchecker) +add_subdirectory(public.sdk/samples/vst/editorhost) +add_subdirectory(public.sdk/samples/vst/mda-vst3) +add_subdirectory(public.sdk/samples/vst/note_expression_synth) +add_subdirectory(public.sdk/samples/vst/note_expression_text) +add_subdirectory(public.sdk/samples/vst/pitchnames) +add_subdirectory(public.sdk/samples/vst/prefetchablesupport) +add_subdirectory(public.sdk/samples/vst/programchange) +add_subdirectory(public.sdk/samples/vst/validator) +add_subdirectory(public.sdk/samples/vst/InterAppAudio) + +set(VSTGUI_DISABLE_UNITTESTS 1) +add_subdirectory(vstgui4/vstgui) + +#------------------------------------------------------------------------------- +# VSTGUI Support Library +#------------------------------------------------------------------------------- +add_compile_options($<$:-DVSTGUI_LIVE_EDITING=1>) +set(VST3_VSTGUI_SOURCES + ${VSTGUI_ROOT}/vstgui4/vstgui/plugin-bindings/vst3groupcontroller.cpp + ${VSTGUI_ROOT}/vstgui4/vstgui/plugin-bindings/vst3groupcontroller.h + ${VSTGUI_ROOT}/vstgui4/vstgui/plugin-bindings/vst3padcontroller.cpp + ${VSTGUI_ROOT}/vstgui4/vstgui/plugin-bindings/vst3padcontroller.h + ${VSTGUI_ROOT}/vstgui4/vstgui/plugin-bindings/vst3editor.cpp + ${VSTGUI_ROOT}/vstgui4/vstgui/plugin-bindings/vst3editor.h + ${SDK_ROOT}/public.sdk/source/vst/vstguieditor.cpp +) +add_library(vstgui_support STATIC ${VST3_VSTGUI_SOURCES}) +target_include_directories(vstgui_support PUBLIC ${VSTGUI_ROOT}/vstgui4) +target_link_libraries(vstgui_support PRIVATE vstgui_uidescription) +if(MAC) + if(XCODE) + target_link_libraries(vstgui_support PRIVATE "-framework Cocoa" "-framework OpenGL" "-framework Accelerate" "-framework QuartzCore" "-framework Carbon") + else() + find_library(COREFOUNDATION_FRAMEWORK CoreFoundation) + find_library(COCOA_FRAMEWORK Cocoa) + find_library(OPENGL_FRAMEWORK OpenGL) + find_library(ACCELERATE_FRAMEWORK Accelerate) + find_library(QUARTZCORE_FRAMEWORK QuartzCore) + find_library(CARBON_FRAMEWORK Carbon) + target_link_libraries(vstgui_support PRIVATE ${COREFOUNDATION_FRAMEWORK} ${COCOA_FRAMEWORK} ${OPENGL_FRAMEWORK} ${ACCELERATE_FRAMEWORK} ${QUARTZCORE_FRAMEWORK} ${CARBON_FRAMEWORK}) + endif() +endif() + +#------------------------------------------------------------------------------- +# IDE sorting +#------------------------------------------------------------------------------- +set_target_properties(vstgui_support PROPERTIES ${SDK_IDE_LIBS_FOLDER}) +set_target_properties(sdk PROPERTIES ${SDK_IDE_LIBS_FOLDER}) +set_target_properties(base PROPERTIES ${SDK_IDE_LIBS_FOLDER}) +set_target_properties(vstgui PROPERTIES ${SDK_IDE_LIBS_FOLDER}) +set_target_properties(vstgui_uidescription PROPERTIES ${SDK_IDE_LIBS_FOLDER}) + +if (TARGET again) + set_target_properties(again PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET againsimple) + set_target_properties(againsimple PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET adelay) + set_target_properties(adelay PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET channelcontext) + set_target_properties(channelcontext PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET hostchecker) + set_target_properties(hostchecker PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET mda-vst3) + set_target_properties(mda-vst3 PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET noteexpressionsynth) + set_target_properties(noteexpressionsynth PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET noteexpressiontext) + set_target_properties(noteexpressiontext PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET pitchnames) + set_target_properties(pitchnames PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET prefetchablesupport) + set_target_properties(prefetchablesupport PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() +if (TARGET programchange) + set_target_properties(programchange PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) +endif() + +if (TARGET editorhost) + set_target_properties(editorhost PROPERTIES ${SDK_IDE_HOSTING_EXAMPLES_FOLDER}) +endif() +if (TARGET validator) + set_target_properties(validator PROPERTIES ${SDK_IDE_HOSTING_EXAMPLES_FOLDER}) +endif () + +if(MAC AND XCODE) + if(SMTG_COREAUDIO_SDK_PATH) + set_target_properties(auwrapper PROPERTIES ${SDK_IDE_LIBS_FOLDER}) + set_target_properties(again_au PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) + endif() + if(IOS_DEVELOPMENT_TEAM) + set_target_properties(sdk_ios PROPERTIES ${SDK_IDE_LIBS_FOLDER}) + set_target_properties(base_ios PROPERTIES ${SDK_IDE_LIBS_FOLDER}) + set_target_properties(interappaudio PROPERTIES ${SDK_IDE_LIBS_FOLDER}) + set_target_properties(noteexpressionsynth_ios PROPERTIES ${SDK_IDE_PLUGIN_EXAMPLES_FOLDER}) + endif() +endif() diff --git a/VST3_SDK/LICENSE.txt b/VST3_SDK/LICENSE.txt new file mode 100644 index 0000000000..e8af8518e0 --- /dev/null +++ b/VST3_SDK/LICENSE.txt @@ -0,0 +1,41 @@ +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +This license applies only to files referencing this license, +for other files of the Software Development Kit the respective embedded license text +is applicable. The license can be found at: www.steinberg.net/sdklicenses_vst3 + +This Software Development Kit is licensed under the terms of the Steinberg VST3 License, +or alternatively under the terms of the General Public License (GPL) Version 3. +You may use the Software Development Kit according to either of these licenses as it is +most appropriate for your project on a case-by-case basis (commercial or not). + +a) Proprietary Steinberg VST3 License +The Software Development Kit may not be distributed in parts or its entirety +without prior written agreement by Steinberg Media Technologies GmbH. +The SDK must not be used to re-engineer or manipulate any technology used +in any Steinberg or Third-party application or software module, +unless permitted by law. +Neither the name of the Steinberg Media Technologies GmbH nor the names of its +contributors may be used to endorse or promote products derived from this +software without specific prior written permission. +Before publishing a software under the proprietary license, you need to obtain a copy +of the License Agreement signed by Steinberg Media Technologies GmbH. +The Steinberg VST SDK License Agreement can be found at: +www.steinberg.net/en/company/developers.html + +THE SDK IS PROVIDED BY STEINBERG MEDIA TECHNOLOGIES GMBH "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL STEINBERG MEDIA TECHNOLOGIES GMBH BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +OF THE POSSIBILITY OF SUCH DAMAGE. + +b) General Public License (GPL) Version 3 +Details of these licenses can be found at: www.gnu.org/licenses/gpl-3.0.html +//---------------------------------------------------------------------------------- diff --git a/VST3_SDK/README.md b/VST3_SDK/README.md new file mode 100644 index 0000000000..9609680395 --- /dev/null +++ b/VST3_SDK/README.md @@ -0,0 +1,92 @@ +# Welcome to VST SDK 3.6.7 +## The VST SDK package contains: +- The VST 3 API +- VST 3 Implementation Helper Classes +- AU and VST2 wrappers +- VST 3 Plug-ins Examples + +The full VST 3 SDK is available [here!](https://www.steinberg.net/en/company/developers.html). It contains a VST 3 Plug-in Test Host Application/Validator. +## System requirements + +Supported OS: + +- Microsoft Windows 7-10 +- Apple OSX 10.7-10.12 +- Apple iOS 8-9 +- Linux (Preview) + +Supported IDE: +- Visual Studio 2013/2015 +- Xcode 6/7 +- Qt Creator + +--- + +## About VST Plug-ins in general +A VST Plug-in is an audio processing component that is utilized within a host application. This host application provides the audio or/and event streams that are processed by the Plug-in's code. Generally speaking, a VST Plug-in can take a stream of audio data, apply a process to the audio, and return the result to the host application. A VST Plug-in performs its process normally using the processor of the computer. The audio stream is broken down into a series of blocks. The host supplies the blocks in sequence. The host and its current environment control the block-size. The VST Plug-in maintains the status of all its own parameters relating to the running process: The host does not maintain any information about what the Plug-in did with the last block of data it processed. + +From the host application's point of view, a VST Plug-in is a black box with an arbitrary number of inputs, outputs (Event (MIDI) or Audio), and associated parameters. The host needs no implicit knowledge of the Plug-in's process to be able to use it. The Plug-in process can use whatever parameters it wishes, internally to the process, but depending on the capabilities of the host, it can allow the changes to user parameters to be automated by the host. + +The source code of a VST Plug-in is platform independent, but the delivery system depends on the platform architecture: +- On **Windows**, a VST Plug-in is a multi-threaded DLL (Dynamic Link Library). +- On **Mac OS X**, a VST Plug-in is a Mach-O Bundle +- On **Linux**, a VST Plug-in is a package + +To learn more about VST you can subscribe to the [VST Developer Forum](https://sdk.steinberg.net) - check the 3rd Party Developer Support section at [www.steinberg.net](www.steinberg.net). + + --- + +## About VST 3 +VST 3 is a general rework of the long-serving VST Plug-in interface. It is not compatible with the older VST versions, but it includes some new features and possibilities. We have redesigned the API to make it not only far easier and more reliable for developers to work with, but have also provided completely new possibilities for Plug-ins. These include: + +### 1. Improved Performance with the Silence Flag +Processing can optionally be applied to Plug-ins only when audio signals are present on their respective inputs, so VST 3 Plug-ins can apply their processing economically and only when it is needed. + +### 2. Multiple Dynamic I/Os +VST 3 Plug-ins are no longer limited to a fixed number of inputs and outputs, and their I/O configuration can dynamically adapt to the channel configuration. Side-chains are also very easily realizable. This includes the possibility to deactivate unused buses after loading and even reactivate those when needed. This cleans up the mixer and further helps to reduce CPU load. + +### 3. Sample-accurate Automation +VST 3 also features vastly improved parameter automation with sample accuracy and support for ramped automation data, allowing completely accurate and rapid parameter automation changes. + +### 4. Logical Parameter Organization +The VST 3 Plug-in parameters are displayed in a tree structure. Parameters are grouped into sections which represent the structure of the Plug-in. Plug-ins can communicate their internal structure for the purpose of overview, but also for some associated functionality (eg. program-lists). + +### 5. Resizeable UI Editor +VST 3 defines a way to allow resizing of the Plug-in editor by a user. + +### 6. Mouse Over Support +The Host could ask the Plug-in which parameter is under the mouse. + +### 7. Context Menu Support +VST 3 defines a way to allow the host to add its own entries in the Plug-in context menu of a specific parameter. + +### 8. Channel Context Information +A VST 3 Plug-in could access some channel information where it is instantiated: name, color,... + +### 9. Note Expression +VST 3 defines with Note Expression a new way of event controller editing. The Plug-in is able to break free from the limitations of MIDI controller events by providing access to new VST 3 controller events that circumvent the laws of MIDI and provide articulation information for each individual note (event) in a polyphonic arrangement according to its noteId. + +### 10. 3D Support +VST 3 supports new speaker configurations like Atmos, Auro 3D or 22.2. + +### 11. Factory Concept +VST 3 Plug-in library could export multiple Plug-ins and in this way replaces the shell concept of VST 2 (kPlugCategShell). + +### 12. Support Remote control Representation +VST 3 Plug-in can deliver a specific parameter mapping for remote controls like Nuage. + +### 13. Others +While designing VST 3, we performed a careful analysis of the existing functionality of VST and rewrote the interfaces from scratch. In doing so, we focused a lot on providing clear interfaces and their documentation in order to avoid usage errors from the deepest possible layer. +Some more features implemented specifically for developers include: +- More stable technical Host/Plug-in environment +- Advanced technical definition of the standard +- Modular approach +- Separation of UI and processing +- Advanced Preset System +- Multiple Plug-ins per Library +- Test Host included +- Automated Testing Environment +- Validator (small command line Test Host) and Plug-in examples code included. +--- +## License +More details are found at [www.steinberg.net/sdklicenses_vst3](www.steinberg.net/sdklicenses_vst3) \ No newline at end of file diff --git a/VST3_SDK/base/CMakeLists.txt b/VST3_SDK/base/CMakeLists.txt new file mode 100644 index 0000000000..32b5e277a3 --- /dev/null +++ b/VST3_SDK/base/CMakeLists.txt @@ -0,0 +1,74 @@ + +set(base_sources + source/baseiids.cpp + source/classfactoryhelpers.h + source/fbuffer.cpp + source/fbuffer.h + source/fcleanup.h + source/fcommandline.h + source/fdebug.cpp + source/fdebug.h + source/fdynlib.cpp + source/fdynlib.h + source/fobject.cpp + source/fobject.h + source/flock.cpp + source/flock.h + source/fstreamer.cpp + source/fstreamer.h + source/fstring.cpp + source/fstring.h + source/timer.cpp + source/timer.h + source/updatehandler.cpp + source/updatehandler.h +) + +set(base_sources_ext + source/basefwd.h + source/classfactory.cpp + source/classfactory.h + source/fatomic.cpp + source/fatomic.h + source/fbitset.cpp + source/fbitset.h + source/fcontainer.h + source/fcpu.cpp + source/fcpu.h + source/fcriticalperformance.cpp + source/fcriticalperformance.h + source/finitializer.cpp + source/finitializer.h + source/fmemory.cpp + source/fmemory.h + source/fpoint.cpp + source/fpoint.h + source/frect.cpp + source/frect.h + source/fregion.cpp + source/fregion.h + source/frwlock_generic.h + source/frwlock_macosx.h + source/frwlock_windows.h + source/fstdmethods.h + source/fstringmethods.h + source/fstringstream.h + source/fthread.cpp + source/fthread.h + source/funknownfactory.h + source/hexbinary.h + source/istreamwrapper.cpp + source/istreamwrapper.h + source/tringbuffer.h +) +if (VST_SDK) + add_library(base STATIC ${base_sources}) +else() + add_library(base STATIC ${base_sources} ${base_sources_ext}) +endif() + +# iOS target +if(MAC AND XCODE AND IOS_DEVELOPMENT_TEAM) + add_library(base_ios STATIC ${base_sources}) + smtg_set_platform_ios(base_ios) +endif() diff --git a/VST3_SDK/base/LICENSE.txt b/VST3_SDK/base/LICENSE.txt new file mode 100644 index 0000000000..c017a1ed70 --- /dev/null +++ b/VST3_SDK/base/LICENSE.txt @@ -0,0 +1,27 @@ +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- diff --git a/VST3_SDK/base/source/baseiids.cpp b/VST3_SDK/base/source/baseiids.cpp new file mode 100644 index 0000000000..0bff401bdf --- /dev/null +++ b/VST3_SDK/base/source/baseiids.cpp @@ -0,0 +1,61 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/baseidds.cpp +// Created by : Steinberg, 01/2008 +// Description : Basic Interface +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "pluginterfaces/base/funknown.h" +#include "pluginterfaces/base/istringresult.h" +#include "pluginterfaces/base/iupdatehandler.h" +#include "pluginterfaces/base/ipersistent.h" +#include "pluginterfaces/base/icloneable.h" +#include "pluginterfaces/base/ibstream.h" + +namespace Steinberg { + +DEF_CLASS_IID (FUnknown) +DEF_CLASS_IID (IString) +DEF_CLASS_IID (IStringResult) + +DEF_CLASS_IID (IDependent) +DEF_CLASS_IID (IUpdateHandler) +DEF_CLASS_IID (IPersistent) +DEF_CLASS_IID (IAttributes) +DEF_CLASS_IID (IAttributes2) + +DEF_CLASS_IID (ICloneable) + +DEF_CLASS_IID (ISizeableStream) +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/classfactoryhelpers.h b/VST3_SDK/base/source/classfactoryhelpers.h new file mode 100644 index 0000000000..12d53fa6df --- /dev/null +++ b/VST3_SDK/base/source/classfactoryhelpers.h @@ -0,0 +1,87 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/classfactoryhelpers.h +// Created by : Steinberg, 03/2017 +// Description : Class factory +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#pragma once + +//------------------------------------------------------------------------------ +// Helper Macros. Not intended for direct use. +// Use: +// META_CLASS(className), +// META_CLASS_IFACE(className,Interface), +// META_CLASS_SINGLE(className,Interface) +// instead. +//------------------------------------------------------------------------------ +#define META_CREATE_FUNC(funcName) static FUnknown* funcName () + +#define CLASS_CREATE_FUNC(className) \ + namespace Meta { \ + META_CREATE_FUNC (make##className) { return (NEW className)->unknownCast (); } \ + } + +#define SINGLE_CREATE_FUNC(className) \ + namespace Meta { \ + META_CREATE_FUNC (make##className) { return className::instance ()->unknownCast (); } \ + } + +#define _META_CLASS(className) \ + namespace Meta { \ + static Steinberg::MetaClass meta##className ((#className), Meta::make##className); \ + } + +#define _META_CLASS_IFACE(className, Interface) \ + namespace Meta { \ + static Steinberg::MetaClass meta##Interface##className ((#className), Meta::make##className, \ + Interface##_iid); \ + } + +/** TODO + */ +#define META_CLASS(className) \ + CLASS_CREATE_FUNC (className) \ + _META_CLASS (className) + +/** TODO + */ +#define META_CLASS_IFACE(className, Interface) \ + CLASS_CREATE_FUNC (className) \ + _META_CLASS_IFACE (className, Interface) + +/** TODO + */ +#define META_CLASS_SINGLE(className, Interface) \ + SINGLE_CREATE_FUNC (className) \ + _META_CLASS_IFACE (className, Interface) diff --git a/VST3_SDK/base/source/fbuffer.cpp b/VST3_SDK/base/source/fbuffer.cpp new file mode 100644 index 0000000000..0c007679ca --- /dev/null +++ b/VST3_SDK/base/source/fbuffer.cpp @@ -0,0 +1,644 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fbuffer.cpp +// Created by : Steinberg, 2008 +// Description : +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "base/source/fbuffer.h" +#include "base/source/fstring.h" +#include + +namespace Steinberg { + +//------------------------------------------------------------------------------------- +Buffer::Buffer () +: buffer (0) +, memSize (0) +, fillSize (0) +, delta (defaultDelta) +{} + +//------------------------------------------------------------------------------------- +Buffer::Buffer (uint32 s, uint8 initVal) +: buffer (0) +, memSize (s) +, fillSize (0) +, delta (defaultDelta) +{ + if (memSize == 0) + return; + buffer = (int8*)::malloc (memSize); + if (buffer) + memset (buffer, initVal, memSize); + else + memSize = 0; +} + +//------------------------------------------------------------------------------------- +Buffer::Buffer (uint32 s) +: buffer (0) +, memSize (s) +, fillSize (0) +, delta (defaultDelta) +{ + if (memSize == 0) + return; + buffer = (int8*)::malloc (memSize); + if (!buffer) + memSize = 0; +} + +//------------------------------------------------------------------------------------- +Buffer::Buffer (const void* b , uint32 s) +: buffer (0) +, memSize (s) +, fillSize (s) +, delta (defaultDelta) +{ + if (memSize == 0) + return; + buffer = (int8*)::malloc (memSize); + if (buffer) + memcpy (buffer, b, memSize); + else + { + memSize = 0; + fillSize = 0; + } +} + +//------------------------------------------------------------------------------------- +Buffer::Buffer (const Buffer& bufferR) +: buffer (0) +, memSize (bufferR.memSize) +, fillSize (bufferR.fillSize) +, delta (bufferR.delta) +{ + if (memSize == 0) + return; + + buffer = (int8*)::malloc (memSize); + if (buffer) + memcpy (buffer, bufferR.buffer, memSize); + else + memSize = 0; +} + +//------------------------------------------------------------------------------------- +Buffer::~Buffer () +{ + if (buffer) + ::free (buffer); + buffer = 0; +} + +//------------------------------------------------------------------------------------- +void Buffer::operator = (const Buffer& b2) +{ + if (&b2 != this) + { + setSize (b2.memSize); + if (b2.memSize > 0 && buffer) + memcpy (buffer, b2.buffer, b2.memSize); + fillSize = b2.fillSize; + delta = b2.delta; + } +} + +//------------------------------------------------------------------------------------- +bool Buffer::operator == (const Buffer& b2)const +{ + if (&b2 == this) + return true; + if (b2.getSize () != getSize ()) + return false; + return memcmp (this->int8Ptr (), b2.int8Ptr (), getSize ()) == 0 ? true : false; +} + +//------------------------------------------------------------------------------------- +uint32 Buffer::get (void* b, uint32 size) +{ + uint32 maxGet = memSize - fillSize; + if (size > maxGet) + size = maxGet; + if (size > 0) + memcpy (b, buffer + fillSize, size); + fillSize += size; + return size; +} + +//------------------------------------------------------------------------------------- +bool Buffer::put (char16 c) +{ + return put ((const void*)&c, sizeof (c)); +} + +//------------------------------------------------------------------------------------- +bool Buffer::put (uint8 byte) +{ + if (grow (fillSize + 1) == false) + return false; + + buffer [fillSize++] = byte; + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::put (char c) +{ + if (grow (fillSize + 1) == false) + return false; + + buffer [fillSize++] = c; + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::put (const void* toPut, uint32 s) +{ + if (!toPut) + return false; + + if (grow (fillSize + s) == false) + return false; + + memcpy (buffer + fillSize, toPut, s); + fillSize += s; + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::put (const String& str) +{ + return put ((const void*)str.text () , (str.length () + 1) * sizeof (tchar)); +} + +//------------------------------------------------------------------------------------- +bool Buffer::appendString8 (const char8* s) +{ + if (!s) + return false; + + uint32 len = (uint32) strlen (s); + return put (s, len); +} + +//------------------------------------------------------------------------------------- +bool Buffer::appendString16 (const char16* s) +{ + if (!s) + return false; + ConstString str (s); + uint32 len = (uint32) str.length () * sizeof (char16); + return put (s, len); +} + +//------------------------------------------------------------------------------------- +bool Buffer::prependString8 (const char8* s) +{ + if (!s) + return false; + + uint32 len = (uint32) strlen (s); + + if (len > 0) + { + shiftStart (len); + memcpy (buffer, s, len); + return true; + } + return false; +} + +//------------------------------------------------------------------------------------- +bool Buffer::prependString16 (const char16* s) +{ + if (!s) + return false; + + ConstString str (s); + uint32 len = (uint32) str.length () * sizeof (char16); + + if (len > 0) + { + shiftStart (len); + memcpy (buffer, s, len); + return true; + } + return false; +} + +//------------------------------------------------------------------------------------- +bool Buffer::prependString8 (char8 c) +{ + shiftStart (sizeof (char)); + char* b = (char*)buffer; + b [0] = c; + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::prependString16 (char16 c) +{ + shiftStart (sizeof (char16)); + char16* b = (char16*)buffer; + b [0] = c; + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::copy (uint32 from, uint32 to, uint32 bytes) +{ + if (from + bytes > memSize || bytes == 0) + return false; + + if (to + bytes > memSize) + setSize (to + bytes); + + if (from + bytes > to && from < to) + { // overlap + Buffer tmp (buffer + from, bytes); + memcpy (buffer + to, tmp, bytes); + } + else + memcpy (buffer + to, buffer + from, bytes); + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::makeHexString (String& result) +{ + unsigned char* data = uint8Ptr (); + uint32 bytes = getSize (); + + if (data == 0 || bytes == 0) + return false; + + char8* stringBuffer = (char8*)malloc ((bytes * 2) + 1); + if (!stringBuffer) + return false; + + int32 count = 0; + while (bytes > 0) + { + unsigned char t1 = ((*data) >> 4) & 0x0F; + unsigned char t2 = (*data) & 0x0F; + if (t1 < 10) + t1 += '0'; + else + t1 = t1 - 10 + 'A'; + if (t2 < 10) + t2 += '0'; + else + t2 = t2 - 10 + 'A'; + + stringBuffer [count++] = t1; + stringBuffer [count++] = t2; + data++; + bytes--; + } + stringBuffer [count] = 0; + + result.take ((void*)stringBuffer, false); + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::fromHexString (const char8* string) +{ + flush (); + if (string == 0) + return false; + + int32 len = strlen8 (string); + if (len == 0 || ((len & 1) == 1)/*odd number*/ ) + return false; + + setSize (len / 2); + unsigned char* data = uint8Ptr (); + + bool upper = true; + int32 count = 0; + while (count < len) + { + char c = string [count]; + + unsigned char d = 0; + if (c >= '0' && c <= '9') d += c - '0'; + else if (c >= 'A' && c <= 'F') d += c - 'A' + 10; + else if (c >= 'a' && c <= 'f') d += c - 'a' + 10; + else return false; // no hex string + + if (upper) + data [count >> 1] = d << 4; + else + data [count >> 1] += d; + + upper = !upper; + count++; + } + setFillSize (len / 2); + return true; +} + +//------------------------------------------------------------------------ +void Buffer::set (uint8 value) +{ + if (buffer) + memset (buffer, value, memSize); +} + +//------------------------------------------------------------------------------------- +bool Buffer::setFillSize (uint32 c) +{ + if (c <= memSize) + { + fillSize = c; + return true; + } + return false; +} + +//------------------------------------------------------------------------------------- +bool Buffer::truncateToFillSize () +{ + if (fillSize < memSize) + setSize (fillSize); + + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::grow (uint32 newSize) +{ + if (newSize > memSize) + { + if (delta == 0) + delta = defaultDelta; + uint32 s = ((newSize + delta - 1) / delta) * delta; + return setSize (s); + } + return true; +} + +//------------------------------------------------------------------------ +void Buffer::shiftAt (uint32 position, int32 amount) +{ + if (amount > 0) + { + if (grow (fillSize + amount)) + { + if (position < fillSize) + memmove (buffer + amount + position, buffer + position, fillSize - position); + + fillSize += amount; + } + } + else if (amount < 0 && fillSize > 0) + { + uint32 toRemove = -amount; + + if (toRemove < fillSize) + { + if (position < fillSize) + memmove (buffer + position, buffer + toRemove + position, fillSize - position - toRemove); + fillSize -= toRemove; + } + } +} + +//------------------------------------------------------------------------------------- +void Buffer::move (int32 amount, uint8 initVal) +{ + if (memSize == 0) + return; + + if (amount > 0) + { + if ((uint32)amount < memSize) + { + memmove (buffer + amount, buffer, memSize - amount); + memset (buffer, initVal, amount); + } + else + memset (buffer, initVal, memSize); + } + else + { + uint32 toRemove = -amount; + if (toRemove < memSize) + { + memmove (buffer, buffer + toRemove, memSize - toRemove); + memset (buffer + memSize - toRemove, initVal, toRemove); + } + else + memset (buffer, initVal, memSize); + } +} + +//------------------------------------------------------------------------------------- +bool Buffer::setSize (uint32 newSize) +{ + if (memSize != newSize) + { + if (buffer) + { + if (newSize > 0) + { + int8* newBuffer = (int8*) ::realloc (buffer, newSize); + if (newBuffer == 0) + { + newBuffer = (int8*)::malloc (newSize); + if (newBuffer) + { + uint32 tmp = newSize; + if (tmp > memSize) + tmp = memSize; + memcpy (newBuffer, buffer, tmp); + ::free (buffer); + buffer = newBuffer; + } + else + { + ::free (buffer); + buffer = 0; + } + } + else + buffer = newBuffer; + } + else + { + ::free (buffer); + buffer = 0; + } + } + else + buffer = (int8*)::malloc (newSize); + + if (newSize > 0 && !buffer) + memSize = 0; + else + memSize = newSize; + if (fillSize > memSize) + fillSize = memSize; + } + + return (newSize > 0) == (buffer != 0); +} + +//------------------------------------------------------------------------------------- +void Buffer::fillup (uint8 value) +{ + if (getFree () > 0) + memset (buffer + fillSize, value, getFree ()); +} + +//------------------------------------------------------------------------------------- +int8* Buffer::operator + (uint32 i) +{ + if (i < memSize) + return buffer + i; + else + { + static int8 eof; + eof = 0; + return &eof; + } +} + +//------------------------------------------------------------------------------------- +bool Buffer::swap (int16 swapSize) +{ + return swap (buffer, memSize, swapSize); +} + +//------------------------------------------------------------------------------------- +bool Buffer::swap (void* buffer, uint32 bufferSize, int16 swapSize) +{ + if (swapSize != kSwap16 && swapSize != kSwap32 && swapSize != kSwap64) + return false; + + if (swapSize == kSwap16) + { + for (uint32 count = 0 ; count < bufferSize ; count += 2) + { + SWAP_16 ( * (((int16*)buffer) + count) ); + } + } + else if (swapSize == kSwap32) + { + for (uint32 count = 0 ; count < bufferSize ; count += 4) + { + SWAP_32 ( * (((int32*)buffer) + count) ); + } + } + else if (swapSize == kSwap64) + { + for (uint32 count = 0 ; count < bufferSize ; count += 8) + { + SWAP_64 ( * (((int64*)buffer) + count) ); + } + } + + return true; +} + +//------------------------------------------------------------------------------------- +void Buffer::take (Buffer& from) +{ + setSize (0); + memSize = from.memSize; + fillSize = from.fillSize; + buffer = from.buffer; + from.buffer = 0; + from.memSize = 0; + from.fillSize = 0; +} + +//------------------------------------------------------------------------------------- +int8* Buffer::pass () +{ + int8* res = buffer; + buffer = 0; + memSize = 0; + fillSize = 0; + return res; +} + +//------------------------------------------------------------------------------------- +bool Buffer::toWideString (int32 sourceCodePage) +{ + if (getFillSize () > 0) + { + if (str8 () [getFillSize () - 1] != 0) // multiByteToWideString only works with 0-terminated strings + endString8 (); + + Buffer dest (getFillSize () * sizeof (char16)); + int32 result = String::multiByteToWideString (dest.str16 (), buffer, dest.getFree () / sizeof (char16), sourceCodePage); + if (result > 0) + { + dest.setFillSize ((result - 1) * sizeof (char16)); + take (dest); + return true; + } + return false; + } + return true; +} + +//------------------------------------------------------------------------------------- +bool Buffer::toMultibyteString (int32 destCodePage) +{ + if (getFillSize () > 0) + { + int32 textLength = getFillSize () / sizeof (char16); // wideStringToMultiByte only works with 0-terminated strings + if (str16 () [textLength - 1] != 0) + endString16 (); + + Buffer dest (getFillSize ()); + int32 result = String::wideStringToMultiByte (dest.str8 (), str16 (), dest.getFree (), destCodePage); + if (result > 0) + { + dest.setFillSize (result - 1); + take (dest); + return true; + } + return false; + } + return true; +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/fbuffer.h b/VST3_SDK/base/source/fbuffer.h new file mode 100644 index 0000000000..6d43e828ef --- /dev/null +++ b/VST3_SDK/base/source/fbuffer.h @@ -0,0 +1,306 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fbuffer.h +// Created by : Steinberg, 2008 +// Description : +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/ftypes.h" +#include + +namespace Steinberg { +class String; + +//------------------------------------------------------------------------ +/** Buffer. +@ingroup adt + +A Buffer is an object-oriented wrapper for a piece of memory. +It adds several utility functions, e.g. for managing the size of the Buffer, +appending or prepending values or strings to it. +Internally it uses the standard memory functions malloc(), free(), etc. */ +//------------------------------------------------------------------------ +class Buffer +{ +public: +//--------------------------------------------------------------------- + + /** Default constructor, allocates no memory at all. + */ + Buffer (); + + /** Constructor - creates a new Buffer with a given size and copies contents from optional memory pointer. + \param[in] b : optional memory pointer with the size of at least the given size + \param[in] size : the size of the new Buffer to be allocated, in bytes. + */ + Buffer (const void* b, uint32 size); + + /** Constructor - creates a new Buffer with a given size and fills it all with a given value. + \param[in] size : the size of the new Buffer to be allocated, in bytes. + \param[in] initVal : the initial value the Buffer will be completely filled with + */ + Buffer (uint32 size, uint8 initVal); + + /** Constructor - creates a new Buffer with a given size. + \param[in] size : the size of the new Buffer to be allocated, in bytes. + */ + Buffer (uint32 size); + + /** Copy constructor - creates a new Buffer from a given Buffer. + \param[in] buff : the Buffer from which all memory will be copied to the new one + */ + Buffer (const Buffer& buff); + + /** Destructor - deallocates the internal memory. + */ + ~Buffer (); + + /** Assignment operator - copies contents from a given Buffer and increases the size if necessary. + \param[in] buff : the Buffer from which all memory will be copied + */ + void operator = (const Buffer& buff); + + /** Comparison operator - copies contents from a given Buffer and increases the size if necessary. + \param[in] buff : the Buffer to be compared to + \return true, if the given Buffer's content is equal to this one, else false + */ + bool operator == (const Buffer& buff)const; + + uint32 getSize () const {return memSize;} ///< \return the actual size of the Buffer's memory, in bytes. + + /** Sets a new size for this Buffer, keeping as much content as possible. + \param[in] newSize : the new size for the Buffer, in bytes, newSize maybe zero + \return true, if the new size could be adapted, else false + */ + bool setSize (uint32 newSize); + + /** Increases the Buffer to the next block, block size given by delta. + \param[in] memSize : the new minimum size of the Buffer, newSize maybe zero + \return true, if the Buffer could be grown successfully, else false + */ + bool grow (uint32 memSize); + bool setMaxSize (uint32 size) {return grow (size);} ///< see \ref grow() + + void fillup (uint8 initVal = 0); ///< set from fillSize to end + uint32 getFillSize ()const {return fillSize;} ///< \return the actual fill size + bool setFillSize (uint32 c); ///< sets a new fill size, does not change any memory + inline void flush () {setFillSize (0);} ///< sets fill size to zero + bool truncateToFillSize (); ///< \return always true, truncates the size of the Buffer to the actual fill size + + bool isFull () const { return (fillSize == memSize); } ///< \return true, if all memory is filled up, else false + uint32 getFree () const { return (memSize - fillSize); }///< \return remaining memory + + inline void shiftStart (int32 amount) {return shiftAt (0, amount);} ///< moves all memory by given amount, grows the Buffer if necessary + void shiftAt (uint32 position, int32 amount); ///< moves memory starting at the given position + void move (int32 amount, uint8 initVal = 0); ///< shifts memory at start without growing the buffer, so data is lost and initialized with init val + + bool copy (uint32 from, uint32 to, uint32 bytes); ///< copies a number of bytes from one position to another, the size may be adapted + uint32 get (void* b, uint32 size); ///< copy to buffer from fillSize, and shift fillSize + + void setDelta (uint32 d) {delta = d;} ///< define the block size by which the Buffer grows, see \ref grow() + + bool put (uint8); ///< append value at end, grows Buffer if necessary + bool put (char16 c); ///< append value at end, grows Buffer if necessary + bool put (char c); ///< append value at end, grows Buffer if necessary + bool put (const void* , uint32 size); ///< append bytes from a given buffer, grows Buffer if necessary + bool put (void* , uint32 size); ///< append bytes from a given buffer, grows Buffer if necessary + bool put (uint8* , uint32 size); ///< append bytes from a given buffer, grows Buffer if necessary + bool put (char8* , uint32 size); ///< append bytes from a given buffer, grows Buffer if necessary + bool put (const uint8* , uint32 size); ///< append bytes from a given buffer, grows Buffer if necessary + bool put (const char8* , uint32 size); ///< append bytes from a given buffer, grows Buffer if necessary + bool put (const String&); ///< append String at end, grows Buffer if necessary + + void set (uint8 value); ///< fills complete Buffer with given value + + // strings ---------------- + bool appendString (const tchar* s); + bool appendString (tchar* s); + bool appendString (tchar c) { return put (c); } + + bool appendString8 (const char8* s); + bool appendString16 (const char16* s); + + bool appendString8 (char8* s) { return appendString8 ((const char8*)s); } + bool appendString8 (unsigned char* s) { return appendString8 ((const char8*)s); } + bool appendString8 (const unsigned char* s) { return appendString8 ((const char8*)s); } + + bool appendString8 (char8 c) { return put ((uint8)c); } + bool appendString8 (unsigned char c) { return put (c); } + bool appendString16 (char16 c) { return put (c); } + bool appendString16 (char16* s) { return appendString16 ((const char16*)s); } + + bool prependString (const tchar* s); + bool prependString (tchar* s); + bool prependString (tchar c); + + bool prependString8 (const char8* s); + bool prependString16 (const char16* s); + + bool prependString8 (char8 c); + bool prependString8 (unsigned char c) { return prependString8 ((char8)c); } + bool prependString8 (char8* s) { return prependString8 ((const char8*)s); } + bool prependString8 (unsigned char* s) { return prependString8((const char8*)s); } + bool prependString8 (const unsigned char* s) { return prependString8 ((const char8*)s); } + bool prependString16 (char16 c); + bool prependString16 (char16* s) { return prependString16 ((const char16*)s); } + + bool operator+= (const char* s) { return appendString8 (s); } + bool operator+= (char c) { return appendString8 (c); } + bool operator+= (const char16* s) { return appendString16 (s); } + bool operator+= (char16 c) { return appendString16 (c); } + + bool operator= (const char* s) { flush (); return appendString8 (s); } + bool operator= (const char16* s) { flush (); return appendString16 (s); } + bool operator= (char8 c) { flush (); return appendString8 (c); } + bool operator= (char16 c) { flush (); return appendString16 (c); } + + void endString () {put (tchar (0));} + void endString8 () {put (char8 (0));} + void endString16 () {put (char16 (0));} + + bool makeHexString (String& result); + bool fromHexString (const char8* string); + + // conversion + operator void* () const { return (void*)buffer; } ///< conversion + inline tchar* str () const {return (tchar*)buffer;} ///< conversion + inline char8* str8 () const {return (char8*)buffer;} ///< conversion + inline char16* str16 () const {return (char16*)buffer;} ///< conversion + inline int8* int8Ptr () const {return (int8*)buffer;} ///< conversion + inline uint8* uint8Ptr () const {return (uint8*)buffer; } ///< conversion + inline int16* int16Ptr () const {return (int16*)buffer; } ///< conversion + inline uint16* uint16Ptr () const {return (uint16*)buffer; } ///< conversion + inline int32* int32Ptr () const {return (int32*)buffer; } ///< conversion + inline uint32* uint32Ptr () const {return (uint32*)buffer; } ///< conversion + inline float* floatPtr () const {return (float*)buffer; } ///< conversion + inline double* doublePtr () const {return (double*)buffer; } ///< conversion + inline char16* wcharPtr () const {return (char16*)buffer;} ///< conversion + + int8* operator + (uint32 i); ///< \return the internal Buffer's address plus the given offset i, zero if offset is out of range + + int32 operator ! () { return buffer == 0; } + + enum swapSize + { + kSwap16 = 2, + kSwap32 = 4, + kSwap64 = 8 + }; + bool swap (int16 swapSize); ///< swap all bytes of this Buffer by the given swapSize + static bool swap (void* buffer, uint32 bufferSize, int16 swapSize); ///< utility, swap given number of bytes in given buffer by the given swapSize + + void take (Buffer& from); ///< takes another Buffer's memory, frees the current Buffer's memory + int8* pass (); ///< pass the current Buffer's memory + + /** Converts a Buffer's content to UTF-16 from a given multi-byte code page, Buffer must contain char8 of given encoding. + \param[in] sourceCodePage : the actual code page of the Buffer's content + \return true, if the conversion was successful, else false + */ + virtual bool toWideString (int32 sourceCodePage); // Buffer contains char8 of given encoding -> utf16 + + /** Converts a Buffer's content from UTF-16 to a given multi-byte code page, Buffer must contain UTF-16 encoded characters. + \param[in] destCodePage : the desired code page to convert the Buffer's content to + \return true, if the conversion was successful, else false + */ + virtual bool toMultibyteString (int32 destCodePage); // Buffer contains utf16 -> char8 of given encoding + +//------------------------------------------------------------------------ +protected: + static const uint32 defaultDelta = 0x1000; // 0x1000 + + int8* buffer; + uint32 memSize; + uint32 fillSize; + uint32 delta; +}; + +inline bool Buffer::put (void* p, uint32 count) { return put ((const void*)p , count ); } +inline bool Buffer::put (uint8 * p, uint32 count) { return put ((const void*)p , count ); } +inline bool Buffer::put (char8* p, uint32 count) { return put ((const void*)p , count ); } +inline bool Buffer::put (const uint8* p, uint32 count) { return put ((const void*)p , count ); } +inline bool Buffer::put (const char8* p, uint32 count) { return put ((const void*)p , count ); } + +//------------------------------------------------------------------------ +inline bool Buffer::appendString (const tchar* s) +{ +#ifdef UNICODE + return appendString16 (s); +#else + return appendString8 (s); +#endif +} + +//------------------------------------------------------------------------ +inline bool Buffer::appendString (tchar* s) +{ +#ifdef UNICODE + return appendString16 (s); +#else + return appendString8 (s); +#endif +} + +//------------------------------------------------------------------------ +inline bool Buffer::prependString (const tchar* s) +{ +#ifdef UNICODE + return prependString16 (s); +#else + return prependString8 (s); +#endif +} + +//------------------------------------------------------------------------ +inline bool Buffer::prependString (tchar* s) +{ +#ifdef UNICODE + return prependString16 (s); +#else + return prependString8 (s); +#endif +} + +//------------------------------------------------------------------------ +inline bool Buffer::prependString (tchar c) +{ +#ifdef UNICODE + return prependString16 (c); +#else + return prependString8 (c); +#endif +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/fcleanup.h b/VST3_SDK/base/source/fcleanup.h new file mode 100644 index 0000000000..9a7557b6dd --- /dev/null +++ b/VST3_SDK/base/source/fcleanup.h @@ -0,0 +1,322 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fcleanup.h +// Created by : Steinberg, 2008 +// Description : Template classes for automatic resource cleanup +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#pragma once + +#include + +namespace Steinberg { + +/** Template definition for classes that help guarding against memory leaks. +A stack allocated object of this type automatically deletes an at construction time passed +dynamically allocated single object when it reaches the end of its scope. \n\n +Intended usage: +\code + { + int* pointerToInt = new int; + Steinberg::FDeleter deleter (pointerToInt); + + // Do something with the variable behind pointerToInt. + + } // No memory leak here, destructor of deleter cleans up the integer. +\endcode +*/ +//------------------------------------------------------------------------ +template +struct FDeleter +{ + /// Constructor. _toDelete is a pointer to the dynamically allocated object that is to be + /// deleted when this FDeleter object's destructor is executed. + FDeleter (T* _toDelete) : toDelete (_toDelete) {} + /// Destructor. Calls delete on the at construction time passed pointer. + ~FDeleter () + { + if (toDelete) + delete toDelete; + } + T* toDelete; ///< Remembers the object that is to be deleted during destruction. +}; + +/** Template definition for classes that help guarding against memory leaks. +A stack allocated object of this type automatically deletes an at construction time passed +dynamically allocated array of objects when it reaches the end of its scope. \n\n +Intended usage: +\code + { + int* pointerToIntArray = new int[10]; + Steinberg::FArrayDeleter deleter (pointerToIntArray); + + // Do something with the array behind pointerToIntArray. + + } // No memory leak here, destructor of deleter cleans up the integer array. +\endcode +*/ +//------------------------------------------------------------------------ +template +struct FArrayDeleter +{ + /// Constructor. _arrayToDelete is a pointer to the dynamically allocated array of objects that + /// is to be deleted when this FArrayDeleter object's destructor is executed. + FArrayDeleter (T* _arrayToDelete) : arrayToDelete (_arrayToDelete) {} + + /// Destructor. Calls delete[] on the at construction time passed pointer. + ~FArrayDeleter () + { + if (arrayToDelete) + delete[] arrayToDelete; + } + + T* arrayToDelete; ///< Remembers the array of objects that is to be deleted during destruction. +}; + +/** Template definition for classes that help guarding against dangling pointers. +A stack allocated object of this type automatically resets an at construction time passed +pointer to null when it reaches the end of its scope. \n\n +Intended usage: +\code + int* pointerToInt = 0; + { + int i = 1; + pointerToInt = &i; + Steinberg::FPtrNuller ptrNuller (pointerToInt); + + // Do something with pointerToInt. + + } // No dangling pointer here, pointerToInt is reset to 0 by destructor of ptrNuller. +\endcode +*/ +//------------------------------------------------------------------------ +template +struct FPtrNuller +{ + /// Constructor. _toNull is a reference to the pointer that is to be reset to NULL when this + /// FPtrNuller object's destructor is executed. + FPtrNuller (T*& _toNull) : toNull (_toNull) {} + /// Destructor. Calls delete[] on the at construction time passed pointer. + ~FPtrNuller () { toNull = 0; } + + T*& toNull; ///< Remembers the pointer that is to be set to NULL during destruction. +}; + +/** Template definition for classes that help resetting an object's value. +A stack allocated object of this type automatically resets the value of an at construction time +passed object to null when it reaches the end of its scope. \n\n Intended usage: \code int theObject += 0; + { + Steinberg::FNuller theNuller (theObject); + + theObject = 1; + + } // Here the destructor of theNuller resets the value of theObject to 0. +\endcode +*/ +//------------------------------------------------------------------------ +template +struct FNuller +{ + /// Constructor. _toNull is a reference to the object that is to be assigned 0 when this FNuller + /// object's destructor is executed. + FNuller (T& _toNull) : toNull (_toNull) {} + /// Destructor. Assigns 0 to the at construction time passed object reference. + ~FNuller () { toNull = 0; } + + T& toNull; ///< Remembers the object that is to be assigned 0 during destruction. +}; + +/** Class definition for objects that help resetting boolean variables. +A stack allocated object of this type automatically sets an at construction time passed +boolean variable immediately to TRUE and resets the same variable to FALSE when it +reaches the end of its own scope. \n\n +Intended usage: +\code + bool theBoolean = false; + { + Steinberg::FBoolSetter theBoolSetter (theBoolean); + // Here the constructor of theBoolSetter sets theBoolean to TRUE. + + // Do something. + + } // Here the destructor of theBoolSetter resets theBoolean to FALSE. +\endcode +*/ +//------------------------------------------------------------------------ +template +struct FBooleanSetter +{ + /// Constructor. _toSet is a reference to the boolean that is set to TRUE immediately in this + /// constructor call and gets reset to FALSE when this FBoolSetter object's destructor is + /// executed. + FBooleanSetter (T& _toSet) : toSet (_toSet) { toSet = true; } + /// Destructor. Resets the at construction time passed boolean to FALSE. + ~FBooleanSetter () { toSet = false; } + + T& toSet; ///< Remembers the boolean that is to be reset during destruction. +}; + +typedef FBooleanSetter FBoolSetter; + +/** Class definition for objects that help setting boolean variables. +A stack allocated object of this type automatically sets an at construction time passed +boolean variable to TRUE if the given condition is met. At the end of its own scope the +stack object will reset the same boolean variable to FALSE, if it wasn't set so already. \n\n +Intended usage: +\code + bool theBoolean = false; + { + bool creativityFirst = true; + Steinberg::FConditionalBoolSetter theCBSetter (theBoolean, creativityFirst); + // Here the constructor of theCBSetter sets theBoolean to the value of creativityFirst. + + // Do something. + + } // Here the destructor of theCBSetter resets theBoolean to FALSE. +\endcode +*/ +//------------------------------------------------------------------------ +struct FConditionalBoolSetter +{ + /// Constructor. _toSet is a reference to the boolean that is to be set. If the in the second + /// parameter given condition is TRUE then also _toSet is set to TRUE immediately. + FConditionalBoolSetter (bool& _toSet, bool condition) : toSet (_toSet) + { + if (condition) + toSet = true; + } + /// Destructor. Resets the at construction time passed boolean to FALSE. + ~FConditionalBoolSetter () { toSet = false; } + + bool& toSet; ///< Remembers the boolean that is to be reset during destruction. +}; + +/** Template definition for classes that help closing resources. +A stack allocated object of this type automatically calls the close method of an at +construction time passed object when it reaches the end of its scope. +It goes without saying that the given type needs to have a close method. \n\n +Intended usage: +\code + struct CloseableObject + { + void close() {}; + }; + + { + CloseableObject theObject; + Steinberg::FCloser theCloser (&theObject); + + // Do something. + + } // Here the destructor of theCloser calls the close method of theObject. +\endcode +*/ +template +struct FCloser +{ + /// Constructor. _obj is the pointer on which close is to be called when this FCloser object's + /// destructor is executed. + FCloser (T* _obj) : obj (_obj) {} + /// Destructor. Calls the close function on the at construction time passed pointer. + ~FCloser () + { + if (obj) + obj->close (); + } + + T* obj; ///< Remembers the pointer on which close is to be called during destruction. +}; + +/** Class definition for objects that help guarding against memory leaks. +A stack allocated object of this type automatically frees the "malloced" memory behind an at +construction time passed pointer when it reaches the end of its scope. +*/ +//------------------------------------------------------------------------ +/*! \class FMallocReleaser + */ +//------------------------------------------------------------------------ +class FMallocReleaser +{ +public: + /// Constructor. _data is the pointer to the memory on which free is to be called when this + /// FMallocReleaser object's destructor is executed. + FMallocReleaser (void* _data) : data (_data) {} + /// Destructor. Calls the free function on the at construction time passed pointer. + ~FMallocReleaser () + { + if (data) + free (data); + } +//------------------------------------------------------------------------ +protected: + void* data; ///< Remembers the pointer on which free is to be called during destruction. +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg + + +#if MAC +typedef const void* CFTypeRef; +extern "C" { + extern void CFRelease (CFTypeRef cf); +} + +namespace Steinberg { + +/** Class definition for objects that helps releasing CoreFoundation objects. +A stack allocated object of this type automatically releases an at construction time +passed CoreFoundation object when it reaches the end of its scope. + +Only available on Macintosh platform. +*/ +//------------------------------------------------------------------------ +/*! \class CFReleaser +*/ +//------------------------------------------------------------------------ +class CFReleaser +{ +public: + /// Constructor. _obj is the reference to an CoreFoundation object which is to be released when this CFReleaser object's destructor is executed. + CFReleaser (CFTypeRef _obj) : obj (_obj) {} + /// Destructor. Releases the at construction time passed object. + ~CFReleaser () { if (obj) CFRelease (obj); } +protected: + CFTypeRef obj; ///< Remembers the object which is to be released during destruction. +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg + +#endif // MAC diff --git a/VST3_SDK/base/source/fcommandline.h b/VST3_SDK/base/source/fcommandline.h new file mode 100644 index 0000000000..d5afcb2e28 --- /dev/null +++ b/VST3_SDK/base/source/fcommandline.h @@ -0,0 +1,344 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fcommandline.h +// Created by : Steinberg, 2007 +// Description : Very simple command-line parser. +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +//------------------------------------------------------------------------ +/** @file base/source/fcommandline.h + Very simple command-line parser. + @see Steinberg::CommandLine */ +//------------------------------------------------------------------------ +#pragma once + +#include +#include +#include +#include +#include + +namespace Steinberg { +//------------------------------------------------------------------------ +/** Very simple command-line parser. + +Parses the command-line into a CommandLine::VariablesMap.\n +The command-line parser uses CommandLine::Descriptions to define the available options. + +@b Example: +\code +#include "base/source/fcommandline.h" +#include + +int main (int argc, char* argv[]) +{ + using namespace std; + using namespace Steinberg; + + CommandLine::Descriptions desc; + CommandLine::VariablesMap valueMap; + + desc.addOptions ("myTool") + ("help", "produce help message") + ("opt1", string(), "option 1") + ("opt2", string(), "option 2") + ; + CommandLine::parse (argc, argv, desc, valueMap); + + if (valueMap.hasError () || valueMap.count ("help")) + { + cout << desc << "\n"; + return 1; + } + if (valueMap.count ("opt1")) + { + cout << "Value of option 1 " << valueMap["opt1"] << "\n"; + } + if (valueMap.count ("opt2")) + { + cout << "Value of option 2 " << valueMap["opt2"] << "\n"; + } + return 0; +} +\endcode +@note +This is a "header only" implementation.\n +If you need the declarations in more than one cpp file, you have to define +@c SMTG_NO_IMPLEMENTATION in all but one file. + +*/ +//------------------------------------------------------------------------ +namespace CommandLine { + + //------------------------------------------------------------------------ + /** Command-line parsing result. + + This is the result of the parser.\n + - Use hasError() to check for errors.\n + - To test if a option was specified on the command-line use: count()\n + - To retrieve the value of an options, use operator [](const VariablesMapContainer::key_type k)\n + */ + //------------------------------------------------------------------------ + class VariablesMap + { + bool mParaError; + typedef std::map VariablesMapContainer; + VariablesMapContainer mVariablesMapContainer; + public: + VariablesMap () : mParaError (false) {} ///< Constructor. Creates a empty VariablesMap. + bool hasError () const { return mParaError; } ///< Returns @c true when an error has occurred. + void setError () { mParaError = true; } ///< Sets the error state to @c true. + std::string& operator [](const VariablesMapContainer::key_type k); ///< Retrieve the value of option @c k. + const std::string& operator [](const VariablesMapContainer::key_type k) const; ///< Retrieve the value of option @c k. + VariablesMapContainer::size_type count (const VariablesMapContainer::key_type k) const; ///< Returns @c != @c 0 if command-line contains option @c k. + }; + + //! type of the list of elements on the command line that are not handled by options parsing + typedef std::vector FilesVector; + + //------------------------------------------------------------------------ + /** The description of one single command-line option. + + Normally you rarely use a Description directly.\n + In most cases you will use the Descriptions::addOptions (const std::string&) method to create and add descriptions. + */ + //------------------------------------------------------------------------ + class Description : public std::string + { + public: + Description (const std::string& name, const std::string& help, const std::string& valueType ); ///< Construct a Description + std::string mHelp; ///< The help string for this option. + std::string mType; ///< The type of this option (kBool, kString). + static const std::string kBool; + static const std::string kString; + }; + //------------------------------------------------------------------------ + /** List of command-line option descriptions. + + Use addOptions(const std::string&) to add Descriptions. + */ + //------------------------------------------------------------------------ + class Descriptions + { + typedef std::deque DescriptionsList; + DescriptionsList mDescriptions; + std::string mCaption; + public: + Descriptions& addOptions (const std::string& caption = ""); ///< Sets the command-line tool caption and starts adding Descriptions. + bool parse (int ac, char* av[], VariablesMap& result, FilesVector* files = 0) const; ///< Parse the command-line. + void print (std::ostream& os) const; ///< Print a brief description for the command-line tool into the stream @c os. + Descriptions& operator() (const std::string& name, const std::string& help); ///< Add a new switch. Only + template Descriptions& operator() (const std::string& name, const Type& inType, std::string help); ///< Add a new option of type @c inType. Currently only std::string is supported. + }; + +//------------------------------------------------------------------------ +// If you need the declarations in more than one cpp file you have to define +// SMTG_NO_IMPLEMENTATION in all but one file. +//------------------------------------------------------------------------ +#ifndef SMTG_NO_IMPLEMENTATION + + //------------------------------------------------------------------------ + /*! If command-line contains option @c k more than once, only the last value will survive. */ + //------------------------------------------------------------------------ + std::string& VariablesMap::operator [](const VariablesMapContainer::key_type k) + { + return mVariablesMapContainer[k]; + } + + //------------------------------------------------------------------------ + /*! If command-line contains option @c k more than once, only the last value will survive. */ + //------------------------------------------------------------------------ + const std::string& VariablesMap::operator [](const VariablesMapContainer::key_type k) const + { + return (*const_cast(this))[k]; + } + + //------------------------------------------------------------------------ + VariablesMap::VariablesMapContainer::size_type VariablesMap::count (const VariablesMapContainer::key_type k) const + { + return mVariablesMapContainer.count (k); + } + + //------------------------------------------------------------------------ + /** Add a new option with a string as parameter. */ + //------------------------------------------------------------------------ + template <> Descriptions& Descriptions::operator() (const std::string& name, const std::string& inType, std::string help) + { + mDescriptions.push_back (Description (name, help, inType)); + return *this; + } + bool parse (int ac, char* av[], const Descriptions& desc, VariablesMap& result, FilesVector* files = 0); ///< Parse the command-line. + std::ostream& operator<< (std::ostream& os, const Descriptions& desc); ///< Make Descriptions stream able. + + const std::string Description::kBool = "bool"; + const std::string Description::kString = "string"; + + //------------------------------------------------------------------------ + /*! In most cases you will use the Descriptions::addOptions (const std::string&) method to create and add descriptions. + + @param[in] name of the option. + @param[in] help a help description for this option. + @param[out] valueType Description::kBool or Description::kString. + */ + //------------------------------------------------------------------------ + Description::Description (const std::string& name, const std::string& help, const std::string& valueType) + : std::string (name) + , mHelp (help) + , mType (valueType) + { + } + + //------------------------------------------------------------------------ + /*! Returning a reverence to *this, enables chaining of calls to operator()(const std::string&, const std::string&). + + @param[in] name of the added option. + @param[in] help a help description for this option. + @return a reverence to *this. + */ + Descriptions& Descriptions::operator() (const std::string& name, const std::string& help) + { + mDescriptions.push_back (Description (name, help, Description::kBool)); + return *this; + } + + //------------------------------------------------------------------------ + /*! Usage example: + @code + CommandLine::Descriptions desc; + desc.addOptions ("myTool") // Set caption to "myTool" + ("help", "produce help message") // add switch -help + ("opt1", string(), "option 1") // add string option -opt1 + ("opt2", string(), "option 2") // add string option -opt2 + ; + @endcode + @note + The operator() is used for every additional option. + @param[in] caption the caption of the command-line tool. + @return a reverense to *this. + */ + //------------------------------------------------------------------------ + Descriptions& Descriptions::addOptions (const std::string& caption) + { + mCaption = caption; + return *this; + } + + //------------------------------------------------------------------------ + /*! @param[in] ac count of command-line parameters + @param[in] av command-line as array of strings + @param[out] result the parsing result + @param[out] files optional list of elements on the command line that are not handled by options parsing + */ + //------------------------------------------------------------------------ + bool Descriptions::parse (int ac, char* av[], VariablesMap& result, FilesVector* files) const + { + using namespace std; + + int i; + for (i = 1; i < ac; i++) + { + string current = av[i]; + if (current[0] == '-') + { + int pos = current[1] == '-' ? 2 : 1; + current = current.substr (pos, string::npos); + + DescriptionsList::const_iterator found = + find (mDescriptions.begin (), mDescriptions.end (), current); + if (found != mDescriptions.end ()) + { + result[*found] = "true"; + if (found->mType != Description::kBool) + { + if (((i + 1) < ac) && *av[i + 1] != '-') + { + result[*found] = av[++i]; + } + else + { + result[*found] = "error!"; + result.setError (); + return false; + } + } + } + else + { + result.setError (); + return false; + } + + } + else if (files) + files->push_back (av[i]); + } + return true; + } + //------------------------------------------------------------------------ + /*! The description includes the help strings for all options. */ + //------------------------------------------------------------------------ + void Descriptions::print (std::ostream& os) const + { + if (!mCaption.empty()) + os << mCaption << ":\n"; + + unsigned int i; + for (i = 0; i < mDescriptions.size (); ++i) + { + const Description& opt = mDescriptions[i]; + os << "-" << opt << ":\t" << opt.mHelp << "\n"; + } + } + + //------------------------------------------------------------------------ + std::ostream& operator<< (std::ostream& os, const Descriptions& desc) + { + desc.print (os); + return os; + } + + //------------------------------------------------------------------------ + /*! @param[in] ac count of command-line parameters + @param[in] av command-line as array of strings + @param[in] desc Descriptions including all allowed options + @param[out] result the parsing result + @param[out] files optional list of elements on the command line that are not handled by options parsing + */ + bool parse (int ac, char* av[], const Descriptions& desc, VariablesMap& result, FilesVector* files) + { + return desc.parse (ac, av, result, files); + } +#endif + +} //namespace CommandLine +} //namespace Steinberg diff --git a/VST3_SDK/base/source/fdebug.cpp b/VST3_SDK/base/source/fdebug.cpp new file mode 100644 index 0000000000..f22c11f98a --- /dev/null +++ b/VST3_SDK/base/source/fdebug.cpp @@ -0,0 +1,270 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fdebug.cpp +// Created by : Steinberg, 1995 +// Description : There are 2 levels of debugging messages: +// DEVELOPMENT During development +// RELEASE Program is shipping. +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "base/source/fdebug.h" + +#if DEVELOPMENT + +#include +#include + +#if WINDOWS +#ifndef _WIN32_WINNT +#define _WIN32_WINNT 0x0400 +#endif +#include +#include +#define vsnprintf _vsnprintf + +#elif MAC +#include +#include +#include +#include +#include +#include +#include +#include +#include + +static bool AmIBeingDebugged (void); + +#define THREAD_ALLOC_WATCH 0 // check allocations on specific threads + + #if THREAD_ALLOC_WATCH + mach_port_t watchThreadID = 0; + #endif + +#endif + +AssertionHandler gAssertionHandler = 0; + +//-------------------------------------------------------------------------- +static const int kDebugPrintfBufferSize = 10000; +static bool neverDebugger = false; // so I can switch it off in the debugger... + +//-------------------------------------------------------------------------- +static void printDebugString (const char* string) +{ + if (!string) + return; + + #if MAC + fprintf (stderr, "%s", string); + + #elif WINDOWS + OutputDebugStringA (string); + #endif +} + + +//-------------------------------------------------------------------------- +// printf style debugging output +//-------------------------------------------------------------------------- +void FDebugPrint (const char *format, ...) +{ + char string[kDebugPrintfBufferSize]; + va_list marker; + va_start (marker, format); + vsnprintf (string, kDebugPrintfBufferSize, format, marker); + + printDebugString (string); +} + + +#if WINDOWS +#define AmIBeingDebugged IsDebuggerPresent +#endif + +#if LINUX +#include +#include +#include +//-------------------------------------------------------------------------- +static inline bool AmIBeingDebugged () +{ +// TODO: check if GDB or LLDB is attached + return true; +} +#endif + +//-------------------------------------------------------------------------- +// printf style debugging output +//-------------------------------------------------------------------------- +void FDebugBreak (const char *format, ...) +{ + char string[kDebugPrintfBufferSize]; + va_list marker; + va_start (marker, format); + vsnprintf (string, kDebugPrintfBufferSize, format, marker); + + printDebugString (string); + + if (neverDebugger) + return; + if (AmIBeingDebugged ()) + { + // do not crash if no debugger present + // If there is an assertion handler defined then let this override the UI + // and tell us whether we want to break into the debugger + bool breakIntoDebugger = true; + if (gAssertionHandler && gAssertionHandler (string) == false) + { + breakIntoDebugger = false; + } + + if (breakIntoDebugger) + { +#if WINDOWS + __debugbreak (); // intrinsic version of DebugBreak() +#elif __ppc64__ || __ppc__ || __arm__ + kill (getpid (), SIGINT); +#elif __i386__ || __x86_64__ + { __asm__ volatile ("int3"); } +#endif + } + } +} + +//-------------------------------------------------------------------------- +void FPrintLastError (const char* file, int line) +{ + #if WINDOWS + LPVOID lpMessageBuffer; + FormatMessageA (FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, + NULL, GetLastError(), MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), + (LPSTR) &lpMessageBuffer, 0, NULL); + FDebugPrint ("%s(%d) : %s\n", file, line, lpMessageBuffer); + LocalFree (lpMessageBuffer); + #endif + + #if MAC + #if !__MACH__ + extern int errno; + #endif + FDebugPrint ("%s(%d) : Errno %d\n", file, line, errno); + #endif +} + + + + +#if MAC + +//------------------------------------------------------------------------ +void* operator new (size_t size, int, const char *file, int line) +{ + #if THREAD_ALLOC_WATCH + mach_port_t threadID = mach_thread_self (); + if (watchThreadID == threadID) + { + FDebugPrint ("Watched Thread Allocation : %s (Line:%d)\n", file ? file : "Unknown", line); + } + #endif + try { + return ::operator new (size); + } catch (std::bad_alloc exception) { FDebugPrint ("bad_alloc exception : %s (Line:%d)", file ? file : "Unknown", line); } + return (void*)-1; +} + +//------------------------------------------------------------------------ +void* operator new [](size_t size, int, const char *file, int line) +{ + #if THREAD_ALLOC_WATCH + mach_port_t threadID = mach_thread_self (); + if (watchThreadID == threadID) + { + FDebugPrint ("Watched Thread Allocation : %s (Line:%d)\n", file ? file : "Unknown", line); + } + #endif + try { + return ::operator new [](size); + } catch (std::bad_alloc exception) { FDebugPrint ("bad_alloc exception : %s (Line:%d)", file ? file : "Unknown", line);} + return (void*)-1; +} + +//------------------------------------------------------------------------ +void operator delete(void* p, int, const char *file, int line) +{ + ::operator delete (p); +} + +//------------------------------------------------------------------------ +void operator delete[](void* p, int, const char *file, int line) +{ + ::operator delete[] (p); +} + +//------------------------------------------------------------------------ +// from Technical Q&A QA1361 (http://developer.apple.com/qa/qa2004/qa1361.html) +//------------------------------------------------------------------------ +bool AmIBeingDebugged(void) + // Returns true if the current process is being debugged (either + // running under the debugger or has a debugger attached post facto). +{ + int mib[4]; + struct kinfo_proc info; + size_t size; + + // Initialize the flags so that, if sysctl fails for some bizarre + // reason, we get a predictable result. + + info.kp_proc.p_flag = 0; + + // Initialize mib, which tells sysctl the info we want, in this case + // we're looking for information about a specific process ID. + + mib[0] = CTL_KERN; + mib[1] = KERN_PROC; + mib[2] = KERN_PROC_PID; + mib[3] = getpid(); + + // Call sysctl. + + size = sizeof(info); + sysctl(mib, sizeof(mib) / sizeof(*mib), &info, &size, NULL, 0); + + // We're being debugged if the P_TRACED flag is set. + + return ( (info.kp_proc.p_flag & P_TRACED) != 0 ); +} + +#endif // MAC + +#endif // DEVELOPMENT diff --git a/VST3_SDK/base/source/fdebug.h b/VST3_SDK/base/source/fdebug.h new file mode 100644 index 0000000000..2dff2d1799 --- /dev/null +++ b/VST3_SDK/base/source/fdebug.h @@ -0,0 +1,206 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fdebug.h +// Created by : Steinberg, 1995 +// Description : There are 2 levels of debugging messages: +// DEVELOPMENT During development +// RELEASE Program is shipping. +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +//----------------------------------------------------------------------------- +/** @file base/source/fdebug.h + Debugging tools. + + There are 2 levels of debugging messages: + - DEVELOPMENT + - During development + - RELEASE + - Program is shipping. +*/ +//----------------------------------------------------------------------------- +#pragma once + +#include "pluginterfaces/base/ftypes.h" +#include + +#if MAC +#include +#endif + +//----------------------------------------------------------------------------- +// development / release +//----------------------------------------------------------------------------- +#if !defined (DEVELOPMENT) && !defined (RELEASE) + #ifdef _DEBUG + #define DEVELOPMENT 1 + #elif defined (NDEBUG) + #define RELEASE 1 + #else + #error DEVELOPMENT, RELEASE, _DEBUG, or NDEBUG must be defined! + #endif +#endif + +//----------------------------------------------------------------------------- +#if WINDOWS + +#undef ASSERT + +/** Disable compiler warning: + * C4291: "No matching operator delete found; memory will not be freed if initialization throws an exception. + * A placement new is used for which there is no placement delete." */ +#if DEVELOPMENT && defined (_MSC_VER) +#pragma warning(disable:4291) +#pragma warning(disable:4985) +#endif + +#endif // WINDOWS + +#if DEVELOPMENT + //----------------------------------------------------------------------------- + /** If "f" is not true and a debugger is present, send an error string to the debugger for display and + cause a breakpoint exception to occur in the current process. ASSERT is removed completely in RELEASE configuration. + So do not pass methods calls to this macro that are expected to exist in the RELEASE build (for method calls that need + to be present in a RELEASE build, use the VERIFY macros instead)*/ + #define ASSERT(f) if (!(f)) FDebugBreak ("%s(%d) : Assert failed: %s\n", __FILE__, __LINE__, #f); + + /** Send "comment" string to the debugger for display. */ + #define WARNING(comment) FDebugPrint ("%s(%d) : %s\n", __FILE__, __LINE__, comment); + + /** Send the last error string to the debugger for display. */ + #define PRINTSYSERROR FPrintLastError(__FILE__, __LINE__); + + /** If a debugger is present, send string "s" to the debugger for display and + cause a breakpoint exception to occur in the current process. */ + #define DEBUGSTR(s) FDebugBreak(s); + + /** Use VERIFY for calling methods "f" having a bool result (expecting them to return 'true') + The call of "f" is not removed in RELEASE builds, only the result verification. eg: VERIFY (isValid ()) */ + #define VERIFY(f) ASSERT(f) + + /** Use VERIFY_IS for calling methods "f" and expect a certain result "r". + The call of "f" is not removed in RELEASE builds, only the result verification. eg: VERIFY_IS (callMethod (), kResultOK) */ + #define VERIFY_IS(f,r) if ((f) != (r)) FDebugBreak ("%s(%d) : Assert failed: %s\n", __FILE__, __LINE__, #f); + + /** Use VERIFY_NOT for calling methods "f" and expect the result to be anything else but "r". + The call of "f" is not removed in RELEASE builds, only the result verification. eg: VERIFY_NOT (callMethod (), kResultError) */ + #define VERIFY_NOT(f,r) if ((f) == (r)) FDebugBreak ("%s(%d) : Assert failed: %s\n", __FILE__, __LINE__, #f); + + /** @name Shortcut macros for sending strings to the debugger for display. + + First parameter is always the format string (printf like). + */ + ///@{ + #define DBPRT0(a) FDebugPrint(a); + #define DBPRT1(a,b) FDebugPrint(a,b); + #define DBPRT2(a,b,c) FDebugPrint(a,b,c); + #define DBPRT3(a,b,c,d) FDebugPrint(a,b,c,d); + #define DBPRT4(a,b,c,d,e) FDebugPrint(a,b,c,d,e); + #define DBPRT5(a,b,c,d,e,f) FDebugPrint(a,b,c,d,e,f); + ///@} + + /** @name Helper functions for the above defined macros. + + You shouldn't use them directly (if you do so, don't forget "#if DEVELOPMENT")! + It is recommended to use the macros instead. + */ + ///@{ + void FDebugPrint (const char *format, ...); + void FDebugBreak (const char *format, ...); + void FPrintLastError (const char* file, int line); + ///@} + + /** @name Provide a custom assertion handler + */ + ///@{ + typedef bool (*AssertionHandler)(const char* message); + extern AssertionHandler gAssertionHandler; + ///@} + + /** Definition of memory allocation macros: + Use "NEW" to allocate storage for individual objects. + Use "NEWVEC" to allocate storage for an array of objects. */ + #if MAC + void* operator new (size_t, int, const char *, int); + void* operator new [] (size_t, int, const char *, int); + void operator delete (void* p, int, const char *file, int line); + void operator delete[] (void* p, int, const char *file, int line); + + #ifndef NEW + #define NEW new (1, __FILE__, __LINE__) + #define NEWVEC new (1, __FILE__, __LINE__) + #endif + + #define DEBUG_NEW DEBUG_NEW_LEAKS + + #elif WINDOWS && defined (_MSC_VER) + #ifndef NEW + void * operator new (size_t, int, const char *, int); + #define NEW new (1, __FILE__, __LINE__) + #define NEWVEC new (1, __FILE__, __LINE__) + #endif + + #else + #ifndef NEW + #define NEW new + #define NEWVEC new + #endif + #endif + +#else + /** if DEVELOPMENT is not set, these macros will do nothing. */ + #define ASSERT(f) + #define WARNING(s) + #define PRINTSYSERROR + #define DEBUGSTR(s) + #define VERIFY(f) f; + #define VERIFY_IS(f,r) f; + #define VERIFY_NOT(f,r) f; + + #define DBPRT0(a) + #define DBPRT1(a,b) + #define DBPRT2(a,b,c) + #define DBPRT3(a,b,c,d) + #define DBPRT4(a,b,c,d,e) + #define DBPRT5(a,b,c,d,e,f) + + #ifndef NEW + #define NEW new + #define NEWVEC new + #endif +#endif + +#if SMTG_CPPUNIT_TESTING +#define SMTG_IS_TEST true +#else +#define SMTG_IS_TEST false +#endif diff --git a/VST3_SDK/base/source/fdynlib.cpp b/VST3_SDK/base/source/fdynlib.cpp new file mode 100644 index 0000000000..523dcf4bc0 --- /dev/null +++ b/VST3_SDK/base/source/fdynlib.cpp @@ -0,0 +1,264 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fdynlib.cpp +// Created by : Steinberg, 1998 +// Description : Dynamic library loading +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "base/source/fdynlib.h" +#include "pluginterfaces/base/fstrdefs.h" +#include "base/source/fstring.h" + +#if WINDOWS +#include + +#elif MAC +#include +#include + +#if !TARGET_OS_IPHONE +static const Steinberg::tchar kUnixDelimiter = STR ('/'); +#endif +#endif + +namespace Steinberg { + +#if MAC +#include + +// we ignore for the moment that the NSAddImage functions are deprecated +#pragma GCC diagnostic ignored "-Wdeprecated-declarations" + +static bool CopyProcessPath (Steinberg::String& name) +{ + Dl_info info; + if (dladdr ((const void*)CopyProcessPath, &info)) + { + if (info.dli_fname) + { + name.assign (info.dli_fname); + #ifdef UNICODE + name.toWideString (); + #endif + return true; + } + } + return false; +} + +#endif + +//------------------------------------------------------------------------ +// FDynLibrary +//------------------------------------------------------------------------ +FDynLibrary::FDynLibrary (const tchar* n, bool addExtension) +: isloaded (false) +, instance (0) +{ + if (n) + init (n, addExtension); +} + +//------------------------------------------------------------------------ +FDynLibrary::~FDynLibrary () +{ + unload (); +} + +//------------------------------------------------------------------------ +bool FDynLibrary::init (const tchar* n, bool addExtension) +{ + if (isLoaded ()) + return true; + + Steinberg::String name (n); + +#if WINDOWS + if (addExtension) + name.append (STR (".dll")); + + instance = LoadLibrary (name); + if (instance) + isloaded = true; + +#elif MAC + isBundle = false; + // first check if it is a bundle + if (addExtension) + name.append (STR (".bundle")); + if (name.getChar16 (0) != STR('/')) // no absoltue path + { + Steinberg::String p; + if (CopyProcessPath (p)) + { + Steinberg::int32 index = p.findLast (STR ('/')); + p.remove (index+1); + name = p + name; + } + } + CFStringRef fsString = (CFStringRef)name.toCFStringRef (); + CFURLRef url = CFURLCreateWithFileSystemPath (NULL, fsString, kCFURLPOSIXPathStyle, true); + if (url) + { + CFBundleRef bundle = CFBundleCreate (NULL, url); + if (bundle) + { + if (CFBundleLoadExecutable (bundle)) + { + isBundle = true; + instance = (void*)bundle; + } + else + CFRelease (bundle); + } + CFRelease (url); + } + CFRelease (fsString); + + name.assign (n); + +#if !TARGET_OS_IPHONE + if (!isBundle) + { + // now we check for a dynamic library + firstSymbol = NULL; + if (addExtension) + { + name.append (STR (".dylib")); + } + // Only if name is a relative path we use the Process Path as root: + if (name[0] != kUnixDelimiter) + { + Steinberg::String p; + if (CopyProcessPath (p)) + { + Steinberg::int32 index = p.findLast (STR ("/")); + p.remove (index+1); + p.append (name); + p.toMultiByte (Steinberg::kCP_Utf8); + instance = (void*) NSAddImage (p, NSADDIMAGE_OPTION_RETURN_ON_ERROR); + } + } + // Last but not least let the system search for it + // + if (instance == 0) + { + name.toMultiByte (Steinberg::kCP_Utf8); + instance = (void*) NSAddImage (name, NSADDIMAGE_OPTION_RETURN_ON_ERROR); + } + } +#endif // !TARGET_OS_IPHONE + + if (instance) + isloaded = true; + +#endif + + return isloaded; +} + +//------------------------------------------------------------------------ +bool FDynLibrary::unload () +{ + if (!isLoaded ()) + return false; + +#if WINDOWS + FreeLibrary ((HINSTANCE)instance); + +#elif MAC + if (isBundle) + { + if (CFGetRetainCount ((CFTypeRef)instance) == 1) + CFBundleUnloadExecutable ((CFBundleRef)instance); + CFRelease ((CFBundleRef)instance); + } + else + { + // we don't use this anymore as the darwin dyld can't unload dynamic libraries yet and may crash +/* if (firstSymbol) + { + NSModule module = NSModuleForSymbol ((NSSymbol)firstSymbol); + if (module) + NSUnLinkModule (module, NSUNLINKMODULE_OPTION_NONE); + }*/ + } +#endif + instance = 0; + isloaded = false; + return true; +} + + +//------------------------------------------------------------------------ +void* FDynLibrary::getProcAddress (const char* name) +{ + if (!isloaded) + return 0; + +#if WINDOWS + return (void*)GetProcAddress ((HINSTANCE)instance, name); + +#elif MAC + if (isBundle) + { + CFStringRef functionName = CFStringCreateWithCString (NULL, name, kCFStringEncodingASCII); + void* result = CFBundleGetFunctionPointerForName ((CFBundleRef)instance, functionName); + CFRelease (functionName); + return result; + } +#if !TARGET_OS_IPHONE + else + { + char* symbolName = (char*) malloc (strlen (name) + 2); + strcpy (symbolName, "_"); + strcat (symbolName, name); + NSSymbol symbol; + symbol = NSLookupSymbolInImage ((const struct mach_header*)instance, symbolName, NSLOOKUPSYMBOLINIMAGE_OPTION_BIND_NOW | NSLOOKUPSYMBOLINIMAGE_OPTION_RETURN_ON_ERROR); + free (symbolName); + if (symbol) + { + if (firstSymbol == NULL) + firstSymbol = symbol; + return NSAddressOfSymbol (symbol); + } + } +#endif // !TARGET_OS_IPHONE + +#endif + + return 0; +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/fdynlib.h b/VST3_SDK/base/source/fdynlib.h new file mode 100644 index 0000000000..21e695f042 --- /dev/null +++ b/VST3_SDK/base/source/fdynlib.h @@ -0,0 +1,112 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fdynlib.h +// Created by : Steinberg, 1998 +// Description : Dynamic library loading +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +//------------------------------------------------------------------------ +/** @file base/source/fdynlib.h + Platform independent dynamic library loading. */ +//------------------------------------------------------------------------ +#pragma once + +#include "pluginterfaces/base/ftypes.h" +#include "base/source/fobject.h" + +namespace Steinberg { + +//------------------------------------------------------------------------ +/** Platform independent dynamic library loader. */ +//------------------------------------------------------------------------ +class FDynLibrary : public FObject +{ +public: +//------------------------------------------------------------------------ + /** Constructor. + + Loads the specified dynamic library. + + @param[in] name the path of the library to load. + @param[in] addExtension if @c true append the platform dependent default extension to @c name. + + @remarks + - If @c name specifies a full path, the FDynLibrary searches only that path for the library. + - If @c name specifies a relative path or a name without path, + FDynLibrary uses a standard search strategy of the current platform to find the library; + - If @c name is @c NULL the library is not loaded. + - Use init() to load the library. */ + FDynLibrary (const tchar* name = 0, bool addExtension = true); + + /** Destructor. + The destructor unloads the library.*/ + ~FDynLibrary (); + + /** Loads the library if not already loaded. + This function is normally called by FDynLibrary(). + @remarks If the library is already loaded, this call has no effect. */ + bool init (const tchar* name, bool addExtension = true); + + /** Returns the address of the procedure @c name */ + void* getProcAddress (const char* name); + + /** Returns true when the library was successfully loaded. */ + bool isLoaded () {return isloaded;} + + /** Unloads the library if it is loaded. + This function is called by ~FDynLibrary (). */ + bool unload (); + + /** Returns the platform dependent representation of the library instance. */ + void* getPlatformInstance () const { return instance; } + +#if MAC + /** Returns @c true if the library is a bundle (Mac only). */ + bool isBundleLib () const {return isBundle;} +#endif + +//------------------------------------------------------------------------ + OBJ_METHODS(FDynLibrary, FObject) +protected: + bool isloaded; + + void* instance; + +#if MAC + void* firstSymbol; + bool isBundle; +#endif +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/flock.cpp b/VST3_SDK/base/source/flock.cpp new file mode 100644 index 0000000000..e5209c4d85 --- /dev/null +++ b/VST3_SDK/base/source/flock.cpp @@ -0,0 +1,142 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/flock.cpp +// Created by : Steinberg, 1995 +// Description : Locks +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#define DEBUG_LOCK 0 + +#include "base/source/flock.h" +#include "base/source/fdebug.h" + +//------------------------------------------------------------------------ +#if WINDOWS +//------------------------------------------------------------------------ +#ifndef WINVER +#define WINVER 0x0500 +#endif +#ifndef _WIN32_WINNT +#define _WIN32_WINNT WINVER +#endif + +#include +#include +#define INIT_CS(cs) \ + InitializeCriticalSection ((LPCRITICAL_SECTION)&cs); + +#endif + +//------------------------------------------------------------------------ +namespace Steinberg { + +//------------------------------------------------------------------------ +// FLock implementation +//------------------------------------------------------------------------ +FLock::FLock (const char8* name) +{ +#if PTHREADS + pthread_mutexattr_t mutexAttr; + pthread_mutexattr_init (&mutexAttr); + pthread_mutexattr_settype (&mutexAttr, PTHREAD_MUTEX_RECURSIVE); + if (pthread_mutex_init (&mutex, &mutexAttr) != 0) + {WARNING("mutex_init failed")} + pthread_mutexattr_destroy (&mutexAttr); + +#elif WINDOWS + INIT_CS (section) +#else +#warning implement FLock! +#endif +} + +//------------------------------------------------------------------------ +FLock::~FLock () +{ +#if PTHREADS + pthread_mutex_destroy (&mutex); + +#elif WINDOWS + DeleteCriticalSection ((LPCRITICAL_SECTION)§ion); + +#endif +} + +//------------------------------------------------------------------------ +void FLock::lock () +{ +#if DEBUG_LOCK + FDebugPrint ("FLock::lock () %x\n", this); +#endif + +#if PTHREADS + pthread_mutex_lock (&mutex); + +#elif WINDOWS + EnterCriticalSection ((LPCRITICAL_SECTION)§ion); + +#endif +} + +//------------------------------------------------------------------------ +void FLock::unlock () +{ +#if DEBUG_LOCK + FDebugPrint ("FLock::unlock () %x\n", this); +#endif + +#if PTHREADS + pthread_mutex_unlock (&mutex); + +#elif WINDOWS + LeaveCriticalSection ((LPCRITICAL_SECTION)§ion); + +#endif +} + +//------------------------------------------------------------------------ +bool FLock::trylock () +{ +#if PTHREADS + return pthread_mutex_trylock (&mutex) == 0; + +#elif WINDOWS + return TryEnterCriticalSection ((LPCRITICAL_SECTION)§ion) != 0 ? true : false; + +#else + return false; +#endif +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/flock.h b/VST3_SDK/base/source/flock.h new file mode 100644 index 0000000000..e6abe76cbb --- /dev/null +++ b/VST3_SDK/base/source/flock.h @@ -0,0 +1,183 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/flock.h +// Created by : Steinberg, 1995 +// Description : locks +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +//---------------------------------------------------------------------------------- +/** @file base/source/flock.h + Locks. */ +/** @defgroup baseLocks Locks */ +//---------------------------------------------------------------------------------- +#pragma once + +#include "fobject.h" +#include "pluginterfaces/base/ftypes.h" + +#if PTHREADS +#include + +#elif WINDOWS +struct CRITSECT // CRITICAL_SECTION +{ + void* DebugInfo; // PRTL_CRITICAL_SECTION_DEBUG DebugInfo; + Steinberg::int32 LockCount; // LONG LockCount; + Steinberg::int32 RecursionCount; // LONG RecursionCount; + void* OwningThread; // HANDLE OwningThread + void* LockSemaphore; // HANDLE LockSemaphore + Steinberg::int32 SpinCount; // ULONG_PTR SpinCount +}; +#endif + +//------------------------------------------------------------------------ +namespace Steinberg { + +//------------------------------------------------------------------------ +/** Lock interface declaration. +@ingroup baseLocks */ +//------------------------------------------------------------------------ +struct ILock +{ +//------------------------------------------------------------------------ + virtual ~ILock () {} + + /** Enables lock. + */ + virtual void lock () = 0; + + /** Disables lock. + */ + virtual void unlock () = 0; + + /** Tries to disable lock. + */ + virtual bool trylock () = 0; + +//------------------------------------------------------------------------ +}; + +//------------------------------------------------------------------------ +/** FLock declaration. +@ingroup baseLocks */ +//------------------------------------------------------------------------ +class FLock : public ILock +{ +public: +//------------------------------------------------------------------------ + + /** Lock constructor. + * @param name lock name + */ + FLock (const char8* name = "FLock"); + + /** Lock destructor. + */ + ~FLock (); + + //-- ILock ----------------------------------------------------------- + virtual void lock () SMTG_OVERRIDE; + virtual void unlock () SMTG_OVERRIDE; + virtual bool trylock () SMTG_OVERRIDE; + //-------------------------------------------------------------------- + +//------------------------------------------------------------------------ +protected: +#if PTHREADS + pthread_mutex_t mutex; ///< Mutex object + +#elif WINDOWS + CRITSECT section; ///< Critical section object + +#endif +}; + +//------------------------------------------------------------------------ +/** FLockObj declaration. Reference counted lock +@ingroup baseLocks */ +//------------------------------------------------------------------------ +class FLockObject : public FObject, public FLock +{ +public: + OBJ_METHODS (FLockObject, FObject) +}; + +//------------------------------------------------------------------------ +/** FGuard - automatic object for locks. +@ingroup baseLocks */ +//------------------------------------------------------------------------ +class FGuard +{ +public: +//------------------------------------------------------------------------ + + /** FGuard constructor. + * @param _lock guard this lock + */ + FGuard (ILock& _lock) : lock (_lock) {lock.lock ();} + + /** FGuard destructor. + */ + ~FGuard () {lock.unlock ();} + +//------------------------------------------------------------------------ +private: + ILock& lock; ///< guarded lock +}; + + +//------------------------------------------------------------------------ +/** Conditional Guard - Locks only if valid lock is passed. +@ingroup baseLocks */ +//------------------------------------------------------------------------ +class FConditionalGuard +{ +public: +//------------------------------------------------------------------------ + + /** FConditionGuard constructor. + * @param _lock guard this lock + */ + FConditionalGuard (FLock* _lock) : lock (_lock) { if (lock) lock->lock (); } + + /** FConditionGuard destructor. + */ + ~FConditionalGuard () { if (lock) lock->unlock (); } + +//------------------------------------------------------------------------ +private: + FLock* lock; ///< guarded lock +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/fobject.cpp b/VST3_SDK/base/source/fobject.cpp new file mode 100644 index 0000000000..a8c5fc33b2 --- /dev/null +++ b/VST3_SDK/base/source/fobject.cpp @@ -0,0 +1,183 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fobject.cpp +// Created by : Steinberg, 2008 +// Description : Basic Object implementing FUnknown +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "base/source/fobject.h" +#include "base/source/flock.h" + +#include + +namespace Steinberg { + +IUpdateHandler* FObject::gUpdateHandler = 0; + +//------------------------------------------------------------------------ +const FUID FObject::iid; + +//------------------------------------------------------------------------ +struct FObjectIIDInitializer +{ + // the object iid is always generated so that different components + // only can cast to their own objects + // this initializer must be after the definition of FObject::iid, otherwise + // the default constructor of FUID will clear the generated iid + FObjectIIDInitializer () + { + const_cast (FObject::iid).generate (); + } +} gFObjectIidInitializer; + +//------------------------------------------------------------------------ +uint32 PLUGIN_API FObject::addRef () +{ + return FUnknownPrivate::atomicAdd (refCount, 1); +} + +//------------------------------------------------------------------------ +uint32 PLUGIN_API FObject::release () +{ + if (FUnknownPrivate::atomicAdd (refCount, -1) == 0) + { + refCount = -1000; + delete this; + return 0; + } + return refCount; +} + +//------------------------------------------------------------------------ +tresult PLUGIN_API FObject::queryInterface (const TUID _iid, void** obj) +{ + QUERY_INTERFACE (_iid, obj, FUnknown::iid, FUnknown) + QUERY_INTERFACE (_iid, obj, IDependent::iid, IDependent) + QUERY_INTERFACE (_iid, obj, FObject::iid, FObject) + *obj = 0; + return kNoInterface; +} + +//------------------------------------------------------------------------ +void FObject::addDependent (IDependent* dep) +{ + if (gUpdateHandler) + gUpdateHandler->addDependent (unknownCast (), dep); +} + +//------------------------------------------------------------------------ +void FObject::removeDependent (IDependent* dep) +{ + if (gUpdateHandler) + gUpdateHandler->removeDependent (unknownCast (), dep); +} + +//------------------------------------------------------------------------ +void FObject::changed (int32 msg) +{ + if (gUpdateHandler) + gUpdateHandler->triggerUpdates (unknownCast (), msg); + else + updateDone (msg); +} + +//------------------------------------------------------------------------ +void FObject::deferUpdate (int32 msg) +{ + if (gUpdateHandler) + gUpdateHandler->deferUpdates (unknownCast (), msg); + else + updateDone (msg); +} + +//------------------------------------------------------------------------ +/** Automatic creation and destruction of singleton instances. */ +//------------------------------------------------------------------------ +namespace Singleton +{ + typedef std::vector ObjectVector; + ObjectVector* singletonInstances = 0; + bool singletonsTerminated = false; + FLock* singletonsLock; + + bool isTerminated () {return singletonsTerminated;} + + void lockRegister () + { + if (!singletonsLock) // assume first call not from multiple threads + singletonsLock = NEW FLock; + singletonsLock->lock (); + } + void unlockRegister () + { + singletonsLock->unlock (); + } + + void registerInstance (FObject** o) + { + ASSERT (singletonsTerminated == false) + if (singletonsTerminated == false) + { + if (singletonInstances == 0) + singletonInstances = NEW std::vector; + singletonInstances->push_back (o); + } + } + + struct Deleter + { + ~Deleter () + { + singletonsTerminated = true; + if (singletonInstances) + { + for (ObjectVector::iterator it = singletonInstances->begin (), + end = singletonInstances->end (); + it != end; ++it) + { + FObject** obj = (*it); + (*obj)->release (); + obj = 0; + } + + delete singletonInstances; + singletonInstances = 0; + } + delete singletonsLock; + singletonsLock = 0; + } + } deleter; +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/fobject.h b/VST3_SDK/base/source/fobject.h new file mode 100644 index 0000000000..099541a54a --- /dev/null +++ b/VST3_SDK/base/source/fobject.h @@ -0,0 +1,518 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fobject.h +// Created by : Steinberg, 2008 +// Description : Basic Object implementing FUnknown +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +//------------------------------------------------------------------------ +/** @file base/source/fobject.h + Basic Object implementing FUnknown. */ +//------------------------------------------------------------------------ +#pragma once + +#include "pluginterfaces/base/funknown.h" +#include "pluginterfaces/base/iupdatehandler.h" +//#include "base/source/basefwd.h" +#include "base/source/fdebug.h" // NEW + + +namespace Steinberg { + +//---------------------------------- + +typedef FIDString FClassID; + +//------------------------------------------------------------------------ +// Basic FObject - implements FUnknown + IDependent +//------------------------------------------------------------------------ +/** Implements FUnknown and IDependent. + +FObject is a polymorphic class that implements IDependent (of SKI module) +and therefore derived from FUnknown, which is the most abstract base class of all. + +All COM-like virtual methods of FUnknown such as queryInterface(), addRef(), release() +are implemented here. On top of that, dependency-related methods are implemented too. + +Pointer casting is done via the template methods FCast, either FObject to FObject or +FUnknown to FObject. + +FObject supports a new singleton concept, therefore these objects are deleted automatically upon program termination. + +- Runtime type information: An object can be queried at runtime, of what class +it is. To do this correctly, every class must override some methods. This +is simplified by using the OBJ_METHODS macros + + +@see + - FUnknown + - IDependent + - IUpdateHandler +*/ +//------------------------------------------------------------------------ +class FObject : public IDependent +{ +public: + //------------------------------------------------------------------------ + FObject () : refCount (1) {} ///< default constructor... + FObject (const FObject&) : refCount (1) {} ///< overloaded constructor... + virtual ~FObject () {} ///< destructor... + FObject& operator = (const FObject&) { return *this; } ///< overloads operator "=" as the reference assignment + + // OBJECT_METHODS + static inline FClassID getFClassID () {return "FObject";} ///< return Class ID as an ASCII string (statically) + virtual FClassID isA () const {return FObject::getFClassID ();} ///< a local alternative to getFClassID () + virtual bool isA (FClassID s) const {return isTypeOf (s, false);} ///< evaluates if the passed ID is of the FObject type + virtual bool isTypeOf (FClassID s, bool /*askBaseClass*/ = true) const {return classIDsEqual (s, FObject::getFClassID ());} + ///< evaluates if the passed ID is of the FObject type + int32 getRefCount () {return refCount;} ///< returns the current interface reference count + FUnknown* unknownCast () {return this;} ///< get FUnknown interface from object + + // FUnknown + virtual tresult PLUGIN_API queryInterface (const TUID _iid, void** obj) SMTG_OVERRIDE; ///< please refer to FUnknown::queryInterface () + virtual uint32 PLUGIN_API addRef () SMTG_OVERRIDE; ///< please refer to FUnknown::addref () + virtual uint32 PLUGIN_API release () SMTG_OVERRIDE; ///< please refer to FUnknown::release () + + // IDependent + virtual void PLUGIN_API update (FUnknown* /*changedUnknown*/, int32 /*message*/) SMTG_OVERRIDE {} + ///< empty virtual method that should be overridden by derived classes for data updates upon changes + // IDependency + virtual void addDependent (IDependent* dep); ///< adds dependency to the object + virtual void removeDependent (IDependent* dep); ///< removes dependency from the object + virtual void changed (int32 msg = kChanged); ///< Inform all dependents, that the object has changed. + virtual void deferUpdate (int32 msg = kChanged); ///< Similar to triggerUpdates, except only delivered in idle (usefull in collecting updates). + virtual void updateDone (int32 /* msg */) {} ///< empty virtual method that should be overridden by derived classes + virtual bool isEqualInstance (IDependent* d) {return static_cast (this) == d;} + + static void setUpdateHandler (IUpdateHandler* handler) {gUpdateHandler = handler;} ///< set method for the local attribute + static IUpdateHandler* getUpdateHandler () {return gUpdateHandler;} ///< get method for the local attribute + + // static helper functions + static inline bool classIDsEqual (FClassID ci1, FClassID ci2); ///< compares (evaluates) 2 class IDs + static inline FObject* unknownToObject (FUnknown* unknown); ///< pointer conversion from FUnknown to FObject + + /** Special UID that is used to cast an FUnknown pointer to a FObject */ + static const FUID iid; + +//------------------------------------------------------------------------ +protected: + int32 refCount; ///< COM-model local reference count + + static IUpdateHandler* gUpdateHandler; +}; + + +//------------------------------------------------------------------------ +// conversion from FUnknown to FObject +//------------------------------------------------------------------------ +inline FObject* FObject::unknownToObject (FUnknown* unknown) +{ + FObject* object = 0; + if (unknown) + { + unknown->queryInterface (FObject::iid, (void**)&object); + if (object) + object->release (); // queryInterface has added ref + } + return object; +} + +//------------------------------------------------------------------------ +inline bool FObject::classIDsEqual (FClassID ci1, FClassID ci2) +{ + return (ci1 && ci2) ? (strcmp (ci1, ci2) == 0) : false; +} + +//----------------------------------------------------------------------- +/** FCast overload 1 - FObject to FObject */ +//----------------------------------------------------------------------- +template +inline C* FCast (const FObject* object) +{ + if (object && object->isTypeOf (C::getFClassID (), true)) + return (C*) object; + return 0; +} + +//----------------------------------------------------------------------- +/** FCast overload 2 - FUnknown to FObject */ +//----------------------------------------------------------------------- +template +inline C* FCast (FUnknown* unknown) +{ + FObject* object = FObject::unknownToObject (unknown); + return FCast (object); +} + +//----------------------------------------------------------------------- +/** FUCast - casting from FUnknown to Interface */ +//----------------------------------------------------------------------- +template +inline C* FUCast (FObject* object) +{ + return FUnknownPtr (object ? object->unknownCast () : 0); +} + +template +inline C* FUCast (FUnknown* object) +{ + return FUnknownPtr (object); +} + +//------------------------------------------------------------------------ +/** @name Convenience methods that call release or delete respectively + on a pointer if it is non-zero, and then set the pointer to zero. + Note: you should prefer using IPtr or OPtr instead of these methods + whenever possible. + Examples: + @code + ~Foo () + { + // instead of ... + if (somePointer) + { + somePointer->release (); + somePointer = 0; + } + // ... just being lazy I write + SafeRelease (somePointer) + } + @endcode +*/ +///@{ +//----------------------------------------------------------------------- +template +inline void SafeRelease (I *& ptr) +{ + if (ptr) + { + ptr->release (); + ptr = 0; + } +} + +//----------------------------------------------------------------------- +template +inline void SafeRelease (IPtr & ptr) +{ + ptr = 0; +} + + +//----------------------------------------------------------------------- +template +inline void SafeDelete (T *& ptr) +{ + if (ptr) + { + delete ptr; + ptr = 0; + } +} +///@} + +//----------------------------------------------------------------------- +template +inline void AssignShared (T*& dest, T* newPtr) +{ + if (dest == newPtr) + return; + + if (dest) + dest->release (); + dest = newPtr; + if (dest) + dest->addRef (); +} + +//----------------------------------------------------------------------- +template +inline void AssignSharedDependent (IDependent* _this, T*& dest, T* newPtr) +{ + if (dest == newPtr) + return; + + if (dest) + dest->removeDependent (_this); + AssignShared (dest, newPtr); + if (dest) + dest->addDependent (_this); +} + +//----------------------------------------------------------------------- +template +inline void AssignSharedDependent (IDependent* _this, IPtr& dest, T* newPtr) +{ + if (dest == newPtr) + return; + + if (dest) + dest->removeDependent (_this); + dest = newPtr; + if (dest) + dest->addDependent (_this); +} + +//----------------------------------------------------------------------- +template +inline void SafeReleaseDependent (IDependent* _this, T*& dest) +{ + if (dest) + dest->removeDependent (_this); + SafeRelease (dest); +} + +//----------------------------------------------------------------------- +template +inline void SafeReleaseDependent (IDependent* _this, IPtr& dest) +{ + if (dest) + dest->removeDependent (_this); + SafeRelease (dest); +} + + +//------------------------------------------------------------------------ +/** Automatic creation and destruction of singleton instances. */ +namespace Singleton { + /** registers an instance (type FObject) */ + void registerInstance (FObject** o); + + /** Returns true when singleton instances were already released. */ + bool isTerminated (); + + /** lock and unlock the singleton registration for multi-threading safety */ + void lockRegister (); + void unlockRegister (); +} + +//------------------------------------------------------------------------ +} // namespace Steinberg + +//----------------------------------------------------------------------- +#define SINGLETON(ClassName) \ + static ClassName* instance (bool create = true) \ + { \ + static Steinberg::FObject* inst = nullptr; \ + if (inst == nullptr && create && Steinberg::Singleton::isTerminated () == false) \ + { \ + Steinberg::Singleton::lockRegister (); \ + if (inst == nullptr) \ + { \ + inst = NEW ClassName; \ + Steinberg::Singleton::registerInstance (&inst); \ + } \ + Steinberg::Singleton::unlockRegister (); \ + } \ + return (ClassName*)inst; \ + } + +//----------------------------------------------------------------------- +#define OBJ_METHODS(className, baseClass) \ + static inline Steinberg::FClassID getFClassID () {return (#className);} \ + virtual Steinberg::FClassID isA () const SMTG_OVERRIDE {return className::getFClassID ();} \ + virtual bool isA (Steinberg::FClassID s) const SMTG_OVERRIDE {return isTypeOf (s, false);} \ + virtual bool isTypeOf (Steinberg::FClassID s, bool askBaseClass = true) const SMTG_OVERRIDE \ + { return (classIDsEqual (s, #className) ? true : (askBaseClass ? baseClass::isTypeOf (s, true) : false)); } + +//------------------------------------------------------------------------ +/** Delegate refcount functions to BaseClass. + BaseClase must implement ref counting. +*/ +//------------------------------------------------------------------------ +#define REFCOUNT_METHODS(BaseClass) \ +virtual Steinberg::uint32 PLUGIN_API addRef ()SMTG_OVERRIDE{ return BaseClass::addRef (); } \ +virtual Steinberg::uint32 PLUGIN_API release ()SMTG_OVERRIDE{ return BaseClass::release (); } + +//------------------------------------------------------------------------ +/** @name Macros to implement FUnknown::queryInterface (). + + Examples: + @code + class Foo : public FObject, public IFoo2, public IFoo3 + { + ... + DEFINE_INTERFACES + DEF_INTERFACE (IFoo2) + DEF_INTERFACE (IFoo3) + END_DEFINE_INTERFACES (FObject) + REFCOUNT_METHODS(FObject) + // Implement IFoo2 interface ... + // Implement IFoo3 interface ... + ... + }; + @endcode +*/ +///@{ +//------------------------------------------------------------------------ +/** Start defining interfaces. */ +//------------------------------------------------------------------------ +#define DEFINE_INTERFACES \ +Steinberg::tresult PLUGIN_API queryInterface (const Steinberg::TUID iid, void** obj) SMTG_OVERRIDE \ +{ + +//------------------------------------------------------------------------ +/** Add a interfaces. */ +//------------------------------------------------------------------------ +#define DEF_INTERFACE(InterfaceName) \ + QUERY_INTERFACE (iid, obj, InterfaceName::iid, InterfaceName) + +//------------------------------------------------------------------------ +/** End defining interfaces. */ +//------------------------------------------------------------------------ +#define END_DEFINE_INTERFACES(BaseClass) \ + return BaseClass::queryInterface (iid, obj); \ +} +///@} + +//------------------------------------------------------------------------ +/** @name Convenient macros to implement Steinberg::FUnknown::queryInterface (). + Examples: + @code + class Foo : public FObject, public IFoo2, public IFoo3 + { + ... + DEF_INTERFACES_2(IFoo2,IFoo3,FObject) + REFCOUNT_METHODS(FObject) + ... + }; + @endcode +*/ +///@{ +//------------------------------------------------------------------------ +#define DEF_INTERFACES_1(InterfaceName,BaseClass) \ +DEFINE_INTERFACES \ +DEF_INTERFACE (InterfaceName) \ +END_DEFINE_INTERFACES (BaseClass) + +//------------------------------------------------------------------------ +#define DEF_INTERFACES_2(InterfaceName1,InterfaceName2,BaseClass) \ +DEFINE_INTERFACES \ +DEF_INTERFACE (InterfaceName1) \ +DEF_INTERFACE (InterfaceName2) \ +END_DEFINE_INTERFACES (BaseClass) + +//------------------------------------------------------------------------ +#define DEF_INTERFACES_3(InterfaceName1,InterfaceName2,InterfaceName3,BaseClass) \ +DEFINE_INTERFACES \ +DEF_INTERFACE (InterfaceName1) \ +DEF_INTERFACE (InterfaceName2) \ +DEF_INTERFACE (InterfaceName3) \ +END_DEFINE_INTERFACES (BaseClass) + +//------------------------------------------------------------------------ +#define DEF_INTERFACES_4(InterfaceName1,InterfaceName2,InterfaceName3,InterfaceName4,BaseClass) \ + DEFINE_INTERFACES \ + DEF_INTERFACE (InterfaceName1) \ + DEF_INTERFACE (InterfaceName2) \ + DEF_INTERFACE (InterfaceName3) \ + DEF_INTERFACE (InterfaceName4) \ + END_DEFINE_INTERFACES (BaseClass) +///@} + +//------------------------------------------------------------------------ +/** @name Convenient macros to implement Steinberg::FUnknown methods. + Examples: + @code + class Foo : public FObject, public IFoo2, public IFoo3 + { + ... + FUNKNOWN_METHODS2(IFoo2,IFoo3,FObject) + ... + }; + @endcode +*/ +///@{ +#define FUNKNOWN_METHODS(InterfaceName,BaseClass) \ +DEF_INTERFACES_1(InterfaceName,BaseClass) \ +REFCOUNT_METHODS(BaseClass) + +#define FUNKNOWN_METHODS2(InterfaceName1,InterfaceName2,BaseClass) \ +DEF_INTERFACES_2(InterfaceName1,InterfaceName2,BaseClass) \ +REFCOUNT_METHODS(BaseClass) + +#define FUNKNOWN_METHODS3(InterfaceName1,InterfaceName2,InterfaceName3,BaseClass) \ +DEF_INTERFACES_3(InterfaceName1,InterfaceName2,InterfaceName3,BaseClass) \ +REFCOUNT_METHODS(BaseClass) + +#define FUNKNOWN_METHODS4(InterfaceName1,InterfaceName2,InterfaceName3,InterfaceName4,BaseClass) \ +DEF_INTERFACES_4(InterfaceName1,InterfaceName2,InterfaceName3,InterfaceName4,BaseClass) \ +REFCOUNT_METHODS(BaseClass) +///@} + + +//------------------------------------------------------------------------ +//------------------------------------------------------------------------ +#if COM_COMPATIBLE +//------------------------------------------------------------------------ +/** @name Macros to implement IUnknown interfaces with FObject. + Examples: + @code + class MyEnumFormat : public FObject, IEnumFORMATETC + { + ... + COM_UNKNOWN_METHODS (IEnumFORMATETC, IUnknown) + ... + }; + @endcode +*/ +///@{ +//------------------------------------------------------------------------ +#define IUNKNOWN_REFCOUNT_METHODS(BaseClass) \ +STDMETHOD_ (ULONG, AddRef) (void) {return BaseClass::addRef ();} \ +STDMETHOD_ (ULONG, Release) (void) {return BaseClass::release ();} + +//------------------------------------------------------------------------ +#define COM_QUERY_INTERFACE(iid, obj, InterfaceName) \ +if (riid == __uuidof(InterfaceName)) \ +{ \ + addRef (); \ + *obj = (InterfaceName*)this; \ + return kResultOk; \ +} + +//------------------------------------------------------------------------ +#define COM_OBJECT_QUERY_INTERFACE(InterfaceName,BaseClass) \ +STDMETHOD (QueryInterface) (REFIID riid, void** object) \ +{ \ + COM_QUERY_INTERFACE (riid, object, InterfaceName) \ + return BaseClass::queryInterface ((FIDString)&riid, object); \ +} + +//------------------------------------------------------------------------ +#define COM_UNKNOWN_METHODS(InterfaceName,BaseClass) \ +COM_OBJECT_QUERY_INTERFACE(InterfaceName,BaseClass) \ +IUNKNOWN_REFCOUNT_METHODS(BaseClass) +///@} + +#endif // COM_COMPATIBLE diff --git a/VST3_SDK/base/source/fstdmethods.h b/VST3_SDK/base/source/fstdmethods.h new file mode 100644 index 0000000000..0430a4b549 --- /dev/null +++ b/VST3_SDK/base/source/fstdmethods.h @@ -0,0 +1,202 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fstdmethods.h +// Created by : Steinberg, 2007 +// Description : Convenient macros to create setter and getter methods. +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +//------------------------------------------------------------------------ +/** @file base/source/fstdmethods.h + Convenient macros to create setter and getter methods. */ +//------------------------------------------------------------------------ +#pragma once + +//---------------------------------------------------------------------------------- +/** @name Methods for flags. + Macros to create setter and getter methods for flags. + + Usage example with DEFINE_STATE: + \code + class MyClass + { + public: + MyClass () : flags (0) {} + DEFINE_FLAG (flags, isFlagged, 1<<0) + DEFINE_FLAG (flags, isMine, 1<<1) + private: + uint32 flags; + }; + void someFunction () + { + MyClass c; + if (c.isFlagged ()) // check the flag + c.isFlagged (false); // set the flag + } + \endcode +*/ +//---------------------------------------------------------------------------------- +///@{ + +/** Create Methods with @c get and @c set prefix. */ +#define DEFINE_STATE(flagVar,methodName,value)\ +void set##methodName (bool state) { if (state) flagVar |= (value); else flagVar &= ~(value); }\ +bool get##methodName ()const { return (flagVar & (value)) != 0; } + +/** Create Methods with @c get prefix. + There is only a 'get' method. */ +#define DEFINE_GETSTATE(flagVar,methodName,value)\ +bool get##methodName ()const { return (flagVar & (value)) != 0; } + +/** Create Methods. + Same name for the getter and setter. */ +#define DEFINE_FLAG(flagVar,methodName,value)\ +void methodName (bool state) { if (state) flagVar |= (value); else flagVar &= ~(value); }\ +bool methodName ()const { return (flagVar & (value)) != 0; } + +/** Create Methods. + There is only a 'get' method. */ +#define DEFINE_GETFLAG(flagVar,methodName,value)\ +bool methodName ()const { return (flagVar & (value)) != 0; } + + +/** Create @c static Methods. + Same name for the getter and setter. */ +#define DEFINE_FLAG_STATIC(flagVar,methodName,value)\ +static void methodName (bool __state) { if (__state) flagVar |= (value); else flagVar &= ~(value); }\ +static bool methodName () { return (flagVar & (value)) != 0; } +///@} + +//---------------------------------------------------------------------------------- +/** @name Methods for data members. + Macros to create setter and getter methods for class members. + + Examples: + \code + class MyClass + { + public: + DATA_MEMBER (double, distance, Distance) + STRING_MEMBER (Steinberg::String, name, Name) + SHARED_MEMBER (FUnknown, userData, UserData) + CLASS_MEMBER (Steinberg::Buffer, bufferData, BufferData) + POINTER_MEMBER (Steinberg::FObject, refOnly, RefOnly) + }; + \endcode +*/ +//-------------------------------------------------------------------------------------- +///@{ + +/** Build-in member (pass by value). */ +#define DATA_MEMBER(type,varName,methodName)\ +public:void set##methodName (type v) { varName = v;}\ +type get##methodName ()const { return varName; }\ +protected: type varName; public: + +//** Object member (pass by reference). */ +#define CLASS_MEMBER(type,varName,methodName)\ +public:void set##methodName (const type& v){ varName = v;}\ +const type& get##methodName () const { return varName; }\ +protected: type varName; public: + +//** Simple pointer. */ +#define POINTER_MEMBER(type,varName,methodName)\ +public:void set##methodName (type* ptr){ varName = ptr;}\ +type* get##methodName ()const { return varName; }\ +private: type* varName; public: + +//** Shared member - FUnknown / FObject / etc */ +#define SHARED_MEMBER(type,varName,methodName)\ +public:void set##methodName (type* v){ varName = v;}\ +type* get##methodName ()const { return varName; }\ +private: IPtr varName; public: + +//** Owned member - FUnknown / FObject / CmObject etc */ +#define OWNED_MEMBER(type,varName,methodName)\ +public:void set##methodName (type* v){ varName = v;}\ +type* get##methodName ()const { return varName; }\ +private: OPtr varName; public: + +//** tchar* / String class member - set by const tchar*, return by reference */ +#define STRING_MEMBER(type,varName,methodName)\ +public:void set##methodName (const tchar* v){ varName = v;}\ +const type& get##methodName () const { return varName; }\ +protected: type varName; public: + +//** char8* / String class member - set by const char8*, return by reference */ +#define STRING8_MEMBER(type,varName,methodName)\ +public:void set##methodName (const char8* v){ varName = v;}\ +const type& get##methodName () const { return varName; }\ +protected: type varName; public: + +//** Standard String Member Steinberg::String */ +#define STRING_MEMBER_STD(varName,methodName) STRING_MEMBER(Steinberg::String,varName,methodName) +#define STRING8_MEMBER_STD(varName,methodName) STRING8_MEMBER(Steinberg::String,varName,methodName) + +///@} + + +// obsolete names +#define DEFINE_VARIABLE(type,varName,methodName) DATA_MEMBER(type,varName,methodName) +#define DEFINE_POINTER(type,varName,methodName) POINTER_MEMBER(type,varName,methodName) +#define DEFINE_MEMBER(type,varName,methodName) CLASS_MEMBER(type,varName,methodName) + + + + + +//------------------------------------------------------------------------ +// for implementing comparison operators using a class member or a compare method: +//------------------------------------------------------------------------ +#define COMPARE_BY_MEMBER_METHODS(className,memberName) \ + bool operator == (const className& other) const {return (memberName == other.memberName);} \ + bool operator != (const className& other) const {return (memberName != other.memberName);} \ + bool operator < (const className& other) const {return (memberName < other.memberName);} \ + bool operator > (const className& other) const {return (memberName > other.memberName);} \ + bool operator <= (const className& other) const {return (memberName <= other.memberName);} \ + bool operator >= (const className& other) const {return (memberName >= other.memberName);} + +#define COMPARE_BY_MEMORY_METHODS(className) \ + bool operator == (const className& other) const {return memcmp (this, &other, sizeof (className)) == 0;} \ + bool operator != (const className& other) const {return memcmp (this, &other, sizeof (className)) != 0;} \ + bool operator < (const className& other) const {return memcmp (this, &other, sizeof (className)) < 0;} \ + bool operator > (const className& other) const {return memcmp (this, &other, sizeof (className)) > 0;} \ + bool operator <= (const className& other) const {return memcmp (this, &other, sizeof (className)) <= 0;} \ + bool operator >= (const className& other) const {return memcmp (this, &other, sizeof (className)) >= 0;} + +#define COMPARE_BY_COMPARE_METHOD(className,methodName) \ + bool operator == (const className& other) const {return methodName (other) == 0;} \ + bool operator != (const className& other) const {return methodName (other) != 0;} \ + bool operator < (const className& other) const {return methodName (other) < 0;} \ + bool operator > (const className& other) const {return methodName (other) > 0;} \ + bool operator <= (const className& other) const {return methodName (other) <= 0; } \ + bool operator >= (const className& other) const {return methodName (other) >= 0; } diff --git a/VST3_SDK/base/source/fstreamer.cpp b/VST3_SDK/base/source/fstreamer.cpp new file mode 100644 index 0000000000..721f106f68 --- /dev/null +++ b/VST3_SDK/base/source/fstreamer.cpp @@ -0,0 +1,726 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fstreamer.cpp +// Created by : Steinberg, 15.12.2005 +// Description : Extract of typed stream i/o methods from FStream +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "fstreamer.h" + +#include "base/source/fstring.h" +#include "base/source/fbuffer.h" +#include "pluginterfaces/base/ibstream.h" + +#ifndef UNICODE +#include "pluginterfaces/base/futils.h" +#endif + +namespace Steinberg { + +//------------------------------------------------------------------------ +// IBStreamer +//------------------------------------------------------------------------ +IBStreamer::IBStreamer (IBStream* stream, int16 _byteOrder) +: FStreamer (_byteOrder) +, stream (stream) +{} + +//------------------------------------------------------------------------ +TSize IBStreamer::readRaw (void* buffer, TSize size) +{ + int32 numBytesRead = 0; + stream->read (buffer, (int32)size, &numBytesRead); + return numBytesRead; +} + +//------------------------------------------------------------------------ +TSize IBStreamer::writeRaw (const void* buffer, TSize size) +{ + int32 numBytesWritten = 0; + stream->write ((void*)buffer, (int32)size, &numBytesWritten); + return numBytesWritten; +} + +//------------------------------------------------------------------------ +int64 IBStreamer::seek (int64 pos, FSeekMode mode) +{ + int64 result = -1; + stream->seek (pos, mode, &result); + return result; +} + +//------------------------------------------------------------------------ +int64 IBStreamer::tell () +{ + int64 pos = 0; + stream->tell (&pos); + return pos; +} + +//------------------------------------------------------------------------ +// FStreamSizeHolder Implementation +//------------------------------------------------------------------------ +FStreamSizeHolder::FStreamSizeHolder (FStreamer &s) +: stream (s), sizePos (-1) +{} + +//------------------------------------------------------------------------ +void FStreamSizeHolder::beginWrite () +{ + sizePos = stream.tell (); + stream.writeInt32 (0L); +} + +//------------------------------------------------------------------------ +int32 FStreamSizeHolder::endWrite () +{ + if (sizePos < 0) + return 0; + + int64 currentPos = stream.tell (); + + stream.seek (sizePos, kSeekSet); + int32 size = int32 (currentPos - sizePos - sizeof (int32)); + stream.writeInt32 (size); + + stream.seek (currentPos, kSeekSet); + return size; +} + +//------------------------------------------------------------------------ +int32 FStreamSizeHolder::beginRead () +{ + sizePos = stream.tell (); + int32 size = 0; + stream.readInt32 (size); + sizePos += size + sizeof (int32); + return size; +} + +//------------------------------------------------------------------------ +void FStreamSizeHolder::endRead () +{ + if (sizePos >= 0) + stream.seek (sizePos, kSeekSet); +} + +//------------------------------------------------------------------------ +// FStreamer +//------------------------------------------------------------------------ +FStreamer::FStreamer (int16 _byteOrder) +: byteOrder (_byteOrder) +{} + +// int8 / char ----------------------------------------------------------- +//------------------------------------------------------------------------ +bool FStreamer::writeChar8 (char8 c) +{ + return writeRaw ((void*)&c, sizeof (char8)) == sizeof (char8); +} + +//------------------------------------------------------------------------ +bool FStreamer::readChar8 (char8& c) +{ + return readRaw ((void*)&c, sizeof (char8)) == sizeof (char8); +} + +//------------------------------------------------------------------------ +bool FStreamer::writeUChar8 (unsigned char c) +{ + return writeRaw ((void*)&c, sizeof (unsigned char)) == sizeof (unsigned char); +} + +//------------------------------------------------------------------------ +bool FStreamer::readUChar8 (unsigned char& c) +{ + return readRaw ((void*)&c, sizeof (unsigned char)) == sizeof (unsigned char); +} + +//------------------------------------------------------------------------ +bool FStreamer::writeChar16 (char16 c) +{ + if (BYTEORDER != byteOrder) + SWAP_16 (c); + return writeRaw ((void*)&c, sizeof (char16)) == sizeof (char16); +} + +//------------------------------------------------------------------------ +bool FStreamer::readChar16 (char16& c) +{ + if (readRaw ((void*)&c, sizeof (char16)) == sizeof (char16)) + { + if (BYTEORDER != byteOrder) + SWAP_16 (c); + return true; + } + c = 0; + return false; +} + +// int16 ----------------------------------------------------------------- +//------------------------------------------------------------------------ +bool FStreamer::writeInt16 (int16 i) +{ + if (BYTEORDER != byteOrder) + SWAP_16 (i); + return writeRaw ((void*)&i, sizeof (int16)) == sizeof (int16); +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt16 (int16& i) +{ + if (readRaw ((void*)&i, sizeof (int16)) == sizeof (int16)) + { + if (BYTEORDER != byteOrder) + SWAP_16 (i); + return true; + } + i = 0; + return false; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt16Array (const int16* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!writeInt16 (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt16Array (int16* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!readInt16 (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt16u (uint16 i) +{ + if (BYTEORDER != byteOrder) + SWAP_16 (i); + return writeRaw ((void*)&i, sizeof (uint16)) == sizeof (uint16); +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt16u (uint16& i) +{ + if (readRaw ((void*)&i, sizeof (uint16)) == sizeof (uint16)) + { + if (BYTEORDER != byteOrder) + SWAP_16 (i); + return true; + } + i = 0; + return false; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt16uArray (const uint16* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!writeInt16u (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt16uArray (uint16* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!readInt16u (array[i])) + return false; + } + return true; +} + +// int32 ----------------------------------------------------------------- +//------------------------------------------------------------------------ +bool FStreamer::writeInt32 (int32 i) +{ + if (BYTEORDER != byteOrder) + SWAP_32 (i); + return writeRaw ((void*)&i, sizeof (int32)) == sizeof (int32); +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt32 (int32& i) +{ + if (readRaw ((void*)&i, sizeof (int32)) == sizeof (int32)) + { + if (BYTEORDER != byteOrder) + SWAP_32 (i); + return true; + } + i = 0; + return false; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt32Array (const int32* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!writeInt32 (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt32Array (int32* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!readInt32 (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt32u (uint32 i) +{ + if (BYTEORDER != byteOrder) + SWAP_32 (i); + return writeRaw ((void*)&i, sizeof (uint32)) == sizeof (uint32); +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt32u (uint32& i) +{ + if (readRaw ((void*)&i, sizeof (uint32)) == sizeof (uint32)) + { + if (BYTEORDER != byteOrder) + SWAP_32 (i); + return true; + } + i = 0; + return false; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt32uArray (const uint32* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!writeInt32u (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt32uArray (uint32* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!readInt32u (array[i])) + return false; + } + return true; +} + +// int64 ----------------------------------------------------------------- +//------------------------------------------------------------------------ +bool FStreamer::writeInt64 (int64 i) +{ + if (BYTEORDER != byteOrder) + SWAP_64 (i); + return writeRaw ((void*)&i, sizeof (int64)) == sizeof (int64); +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt64 (int64& i) +{ + if (readRaw ((void*)&i, sizeof (int64)) == sizeof (int64)) + { + if (BYTEORDER != byteOrder) + SWAP_64 (i); + return true; + } + i = 0; + return false; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt64Array (const int64* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!writeInt64 (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt64Array (int64* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!readInt64 (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt64u (uint64 i) +{ + if (BYTEORDER != byteOrder) + SWAP_64 (i); + return writeRaw ((void*)&i, sizeof (uint64)) == sizeof (uint64); +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt64u (uint64& i) +{ + if (readRaw ((void*)&i, sizeof (uint64)) == sizeof (uint64)) + { + if (BYTEORDER != byteOrder) + SWAP_64 (i); + return true; + } + i = 0; + return false; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeInt64uArray (const uint64* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!writeInt64u (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readInt64uArray (uint64* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!readInt64u (array[i])) + return false; + } + return true; +} + +// float / double -------------------------------------------------------- +//------------------------------------------------------------------------ +bool FStreamer::writeFloat (float f) +{ + if (BYTEORDER != byteOrder) + SWAP_32 (f); + return writeRaw ((void*)&f, sizeof (float)) == sizeof (float); +} + +//------------------------------------------------------------------------ +bool FStreamer::readFloat (float& f) +{ + if (readRaw ((void*)&f, sizeof (float)) == sizeof (float)) + { + if (BYTEORDER != byteOrder) + SWAP_32 (f); + return true; + } + f = 0.f; + return false; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeFloatArray (const float* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!writeFloat (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readFloatArray (float* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!readFloat (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeDouble (double d) +{ + if (BYTEORDER != byteOrder) + SWAP_64 (d); + return writeRaw ((void*)&d, sizeof (double)) == sizeof (double); +} + +//------------------------------------------------------------------------ +bool FStreamer::readDouble (double& d) +{ + if (readRaw ((void*)&d, sizeof (double)) == sizeof (double)) + { + if (BYTEORDER != byteOrder) + SWAP_64 (d); + return true; + } + d = 0.0; + return false; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeDoubleArray (const double* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!writeDouble (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readDoubleArray (double* array, int32 count) +{ + for (int32 i = 0; i < count; i++) + { + if (!readDouble (array[i])) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::readBool (bool& b) +{ + int16 v = 0; + bool res = readInt16 (v); + b = (v != 0); + return res; +} + +//------------------------------------------------------------------------ +bool FStreamer::writeBool (bool b) +{ + return writeInt16 ((int16)b); +} + +//------------------------------------------------------------------------ +TSize FStreamer::writeString8 (const char8* ptr, bool terminate) +{ + TSize size = strlen (ptr); + if (terminate) // write \0 + size++; + + return writeRaw ((void*)ptr, size); +} + +//------------------------------------------------------------------------ +TSize FStreamer::readString8 (char8* ptr, TSize size) +{ + TSize i = 0; + char8 c = 0; + while (i < size) + { + if (readRaw ((void*)&c, sizeof (char)) != sizeof (char)) + break; + ptr[i] = c; + i++; + if (c == '\n' || c == '\0') + break; + } + if (c == '\n' && ptr[i - 2] == '\r') + ptr[i - 2] = 0; + if (i < size) + ptr[i] = 0; + else + ptr[size - 1] = 0; + + return strlen (ptr); +} + +//------------------------------------------------------------------------ +bool FStreamer::writeStringUtf8 (const tchar* ptr) +{ + bool isUtf8 = false; + + String str (ptr); + if (str.isAsciiString () == false) + { + str.toMultiByte (kCP_Utf8); + isUtf8 = true; + } + else + { + str.toMultiByte (); + } + + if (isUtf8) + if (writeRaw (kBomUtf8, kBomUtf8Length) != kBomUtf8Length) + return false; + + TSize size = str.length () + 1; + if (writeRaw (str.text8 (), size) != size) + return false; + + return true; +} + +//------------------------------------------------------------------------ +int32 FStreamer::readStringUtf8 (tchar* ptr, int32 nChars) +{ + char8 c = 0; + + ptr [0] = 0; + + Buffer tmp; + tmp.setDelta (1024); + + while (true) + { + if (readRaw ((void*)&c, sizeof (char)) != sizeof (char)) + break; + tmp.put (c); + if (c == '\0') + break; + } + + char8* source = tmp.int8Ptr (); + uint32 codePage = kCP_Default; // for legacy take default page if no utf8 bom is present... + if (tmp.getFillSize () > 2) + { + if (memcmp (source, kBomUtf8, kBomUtf8Length) == 0) + { + codePage = kCP_Utf8; + source += 3; + } + } + + if (tmp.getFillSize () > 1) + { +#ifdef UNICODE + ConstString::multiByteToWideString (ptr, source, nChars, codePage); +#else + if (codePage == kCP_Utf8) + { + Buffer wideBuffer (tmp.getFillSize () * 3); + ConstString::multiByteToWideString (wideBuffer.wcharPtr (), source, wideBuffer.getSize () / 2, kCP_Utf8); + ConstString::wideStringToMultiByte (ptr, wideBuffer.wcharPtr (), nChars); + } + else + { + memcpy (ptr, source, Min (nChars, tmp.getFillSize ())); + } +#endif + } + + ptr[nChars - 1] = 0; + return ConstString (ptr).length (); +} + +//------------------------------------------------------------------------ +bool FStreamer::writeStr8 (const char8* s) +{ + int32 length = (s) ? (int32) strlen (s) + 1 : 0; + if (!writeInt32 (length)) + return false; + + if (length > 0) + return writeRaw (s, sizeof (char8) * length) == sizeof (char8) * length; + + return true; +} + +//------------------------------------------------------------------------ +int32 FStreamer::getStr8Size (const char8* s) +{ + return sizeof (int32) + (int32)strlen (s) + 1; +} + +//------------------------------------------------------------------------ +char8* FStreamer::readStr8 () +{ + int32 length; + if (!readInt32 (length)) + return 0; + + // check corruption + if (length > 262144) + return 0; + + char8* s = (length > 0) ? NEWVEC char8[length] : 0; + if (s) + readRaw (s, length * sizeof (char8)); + return s; +} + +//------------------------------------------------------------------------ +bool FStreamer::skip (uint32 bytes) +{ + int8 tmp; + while (bytes-- > 0) + { + if (readInt8 (tmp) == false) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +bool FStreamer::pad (uint32 bytes) +{ + while (bytes-- > 0) + { + if (writeInt8 (0) == false) + return false; + } + return true; +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/fstreamer.h b/VST3_SDK/base/source/fstreamer.h new file mode 100644 index 0000000000..78155d3aff --- /dev/null +++ b/VST3_SDK/base/source/fstreamer.h @@ -0,0 +1,242 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fstreamer.h +// Created by : Steinberg, 12/2005 +// Description : Extract of typed stream i/o methods from FStream +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/funknown.h" + +namespace Steinberg { + +//------------------------------------------------------------------------ +enum FSeekMode +{ + kSeekSet, + kSeekCurrent, + kSeekEnd +}; + +//------------------------------------------------------------------------ +// FStreamer +//------------------------------------------------------------------------ +/** Byteorder-aware base class for typed stream i/o. */ +//------------------------------------------------------------------------ +class FStreamer +{ +public: +//------------------------------------------------------------------------ + FStreamer (int16 byteOrder = BYTEORDER); + virtual ~FStreamer () {} + + /** @name Implementing class must override. */ + ///@{ + virtual TSize readRaw (void*, TSize) = 0; ///< Read one buffer of size. + virtual TSize writeRaw (const void*, TSize) = 0; ///< Write one buffer of size. + virtual int64 seek (int64, FSeekMode) = 0; ///< Set file position for stream. + virtual int64 tell () = 0; ///< Return current file position. + ///@} + + /** @name Streams are byteOrder aware. */ + ///@{ + inline void setByteOrder (int32 e) { byteOrder = (int16)e; } + inline int32 getByteOrder () { return byteOrder; } + ///@} + + /** @name read and write int8 and char. */ + ///@{ + bool writeChar8 (char8); + bool readChar8 (char8&); + bool writeUChar8 (unsigned char); + bool readUChar8 (unsigned char&); + bool writeChar16 (char16 c); + bool readChar16 (char16& c); + + bool writeInt8 (int8 c){return writeChar8 (c);} + bool readInt8 (int8& c){return readChar8 (c);} + bool writeInt8u (uint8 c){return writeUChar8 (c);} + bool readInt8u (uint8& c){return readUChar8 (c);} + ///@} + + /** @name read and write int16. */ + ///@{ + bool writeInt16 (int16); + bool readInt16 (int16&); + bool writeInt16Array (const int16* array, int32 count); + bool readInt16Array (int16* array, int32 count); + bool writeInt16u (uint16); + bool readInt16u (uint16&); + bool writeInt16uArray (const uint16* array, int32 count); + bool readInt16uArray (uint16* array, int32 count); + ///@} + + /** @name read and write int32. */ + ///@{ + bool writeInt32 (int32); + bool readInt32 (int32&); + bool writeInt32Array (const int32* array, int32 count); + bool readInt32Array (int32* array, int32 count); + bool writeInt32u (uint32); + bool readInt32u (uint32&); + bool writeInt32uArray (const uint32* array, int32 count); + bool readInt32uArray (uint32* array, int32 count); + ///@} + + /** @name read and write int64. */ + ///@{ + bool writeInt64 (int64); + bool readInt64 (int64&); + bool writeInt64Array (const int64* array, int32 count); + bool readInt64Array (int64* array, int32 count); + bool writeInt64u (uint64); + bool readInt64u (uint64&); + bool writeInt64uArray (const uint64* array, int32 count); + bool readInt64uArray (uint64* array, int32 count); + ///@} + + /** @name read and write float and float array. */ + ///@{ + bool writeFloat (float); + bool readFloat (float&); + bool writeFloatArray (const float* array, int32 count); + bool readFloatArray (float* array, int32 count); + ///@} + + /** @name read and write double and double array. */ + ///@{ + bool writeDouble (double); + bool readDouble (double&); + bool writeDoubleArray (const double* array, int32 count); + bool readDoubleArray (double* array, int32 count); + ///@} + + /** @name read and write Boolean. */ + ///@{ + bool writeBool (bool); ///< Write one boolean + bool readBool (bool&); ///< Read one bool. + ///@} + + /** @name read and write Strings. */ + ///@{ + TSize writeString8 (const char8* ptr, bool terminate = false); ///< a direct output function writing only one string (ascii 8bit) + TSize readString8 (char8* ptr, TSize size); ///< a direct input function reading only one string (ascii) (ended by a \n or \0 or eof) + + bool writeStr8 (const char8* ptr); ///< write a string length (strlen) and string itself + char8* readStr8 (); ///< read a string length and string text (The return string must be deleted when use is finished) + + static int32 getStr8Size (const char8* ptr); ///< returns the size of a saved string + + bool writeStringUtf8 (const tchar* ptr); ///< always terminated, converts to utf8 if non ascii characters are in string + int32 readStringUtf8 (tchar* ptr, int32 maxSize); ///< read a UTF8 string + ///@} + + bool skip (uint32 bytes); + bool pad (uint32 bytes); + + +//------------------------------------------------------------------------ +protected: + int16 byteOrder; +}; + + +//------------------------------------------------------------------------ +/** FStreamSizeHolder Declaration + remembers size of stream chunk for backward compatibility. + + Example: + @code + externalize (a) + { + FStreamSizeHolder sizeHolder; + sizeHolder.beginWrite (); // sets start mark, writes dummy size + a << .... + sizeHolder.endWrite (); // jumps to start mark, updates size, jumps back here + } + + internalize (a) + { + FStreamSizeHolder sizeHolder; + sizeHolder.beginRead (); // reads size, mark + a >> .... + sizeHolder.endRead (); // jumps forward if new version has larger size + } + @endcode +*/ +//------------------------------------------------------------------------ +class FStreamSizeHolder +{ +public: + FStreamSizeHolder (FStreamer &s); + + void beginWrite (); ///< remembers position and writes 0 + int32 endWrite (); ///< writes and returns size (since the start marker) + int32 beginRead (); ///< returns size + void endRead (); ///< jump to end of chunk + +protected: + FStreamer &stream; + int64 sizePos; +}; + +class IBStream; + +//------------------------------------------------------------------------ +// IBStreamer +//------------------------------------------------------------------------ +/** Wrapper class for typed reading/writing from or to IBStream. + Can be used framework-independent in Plug-ins. */ +//------------------------------------------------------------------------ +class IBStreamer: public FStreamer +{ +public: +//------------------------------------------------------------------------ + /** Constructor for a given IBSTream and a byteOrder. */ + IBStreamer (IBStream* stream, int16 byteOrder = BYTEORDER); + + IBStream* getStream () { return stream; } ///< Returns the associated IBStream. + + // FStreamer overrides: + TSize readRaw (void*, TSize) SMTG_OVERRIDE; ///< Read one buffer of size. + TSize writeRaw (const void*, TSize) SMTG_OVERRIDE; ///< Write one buffer of size. + int64 seek (int64, FSeekMode) SMTG_OVERRIDE; ///< Set file position for stream. + int64 tell () SMTG_OVERRIDE; ///< Return current file position. +//------------------------------------------------------------------------ +protected: + IBStream* stream; +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/fstring.cpp b/VST3_SDK/base/source/fstring.cpp new file mode 100644 index 0000000000..60182b745c --- /dev/null +++ b/VST3_SDK/base/source/fstring.cpp @@ -0,0 +1,4001 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fstring.cpp +// Created by : Steinberg, 2008 +// Description : String class +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "base/source/fstring.h" +#include "base/source/fdebug.h" +#include "pluginterfaces/base/futils.h" +#include "pluginterfaces/base/fvariant.h" + +#include +#include +#include +#include +#include + +#if WINDOWS +#include +#pragma warning (disable : 4244) +#pragma warning (disable : 4267) +#pragma warning (disable : 4996) + +#if DEVELOPMENT +#include + +#define malloc(s) _malloc_dbg(s, _NORMAL_BLOCK, __FILE__, __LINE__) +#define realloc(p,s) _realloc_dbg(p,s, _NORMAL_BLOCK, __FILE__, __LINE__) +#define free(p) _free_dbg(p, _NORMAL_BLOCK) + +#endif + +#endif + +#ifndef kPrintfBufferSize +#define kPrintfBufferSize 4096 +#endif + +#if MAC +#include +#include +#include +#include + +#if defined (__GNUC__) && (__GNUC__ >= 4) && !__LP64__ +// on 32 bit Mac OS X we can safely ignore the format warnings as sizeof(int) == sizeof(long) +#pragma GCC diagnostic ignored "-Wformat" +#endif + +#define SMTG_ENABLE_DEBUG_CFALLOCATOR 0 +#define SMTG_DEBUG_CFALLOCATOR (DEVELOPMENT && SMTG_ENABLE_DEBUG_CFALLOCATOR) + +#if SMTG_DEBUG_CFALLOCATOR +#include +#include +#endif + +namespace Steinberg { +#if SMTG_DEBUG_CFALLOCATOR +static CFAllocatorRef kCFAllocator = NULL; + +struct CFStringDebugAllocator : CFAllocatorContext +{ + CFStringDebugAllocator () + { + version = 0; + info = this; + retain = nullptr; + release = nullptr; + copyDescription = nullptr; + allocate = allocateCallBack; + reallocate = reallocateCallBack; + deallocate = deallocateCallBack; + preferredSize = preferredSizeCallBack; + + numAllocations = allocationSize = numDeallocations = 0; + cfAllocator = CFAllocatorCreate (kCFAllocatorUseContext, this); + + Dl_info info; + if (dladdr ((const void*)CFStringDebugAllocator::allocateCallBack, &info)) + { + moduleName = info.dli_fname; + } + kCFAllocator = cfAllocator; + } + + ~CFStringDebugAllocator () + { + kCFAllocator = kCFAllocatorDefault; + CFRelease (cfAllocator); + FDebugPrint ("CFStringDebugAllocator (%s):\n", moduleName.text8 ()); + FDebugPrint ("\tNumber of allocations : %u\n", numAllocations); + FDebugPrint ("\tNumber of deallocations: %u\n", numDeallocations); + FDebugPrint ("\tAllocated Bytes : %u\n", allocationSize); + } + + String moduleName; + CFAllocatorRef cfAllocator; + volatile int64_t numAllocations; + volatile int64_t numDeallocations; + volatile int64_t allocationSize; + + void* doAllocate (CFIndex allocSize, CFOptionFlags hint) + { + void* ptr = CFAllocatorAllocate (kCFAllocatorDefault, allocSize, hint); + OSAtomicIncrement64 (&numAllocations); + OSAtomicAdd64 (allocSize, &allocationSize); + return ptr; + } + void* doReallocate (void* ptr, CFIndex newsize, CFOptionFlags hint) + { + void* newPtr = CFAllocatorReallocate (kCFAllocatorDefault, ptr, newsize, hint); + return newPtr; + } + void doDeallocate (void* ptr) + { + CFAllocatorDeallocate (kCFAllocatorDefault, ptr); + OSAtomicIncrement64 (&numDeallocations); + } + CFIndex getPreferredSize (CFIndex size, CFOptionFlags hint) + { + return CFAllocatorGetPreferredSizeForSize (kCFAllocatorDefault, size, hint); + } + + static void* allocateCallBack (CFIndex allocSize, CFOptionFlags hint, void* info) + { + return static_cast (info)->doAllocate (allocSize, hint); + } + static void* reallocateCallBack (void* ptr, CFIndex newsize, CFOptionFlags hint, void* info) + { + return static_cast (info)->doReallocate (ptr, newsize, hint); + } + + static void deallocateCallBack (void* ptr, void* info) + { + static_cast (info)->doDeallocate (ptr); + } + static CFIndex preferredSizeCallBack (CFIndex size, CFOptionFlags hint, void* info) + { + return static_cast (info)->getPreferredSize (size, hint); + } +}; +static CFStringDebugAllocator gDebugAllocator; +#else + +static const CFAllocatorRef kCFAllocator = ::kCFAllocatorDefault; +#endif +} + +//----------------------------------------------------------------------------- +static void* toCFStringRef (const Steinberg::char8* source, Steinberg::uint32 encoding) +{ + if (encoding == 0xFFFF) + encoding = kCFStringEncodingASCII; + if (source) + return (void*)CFStringCreateWithCString (Steinberg::kCFAllocator, source, encoding); + else + return (void*)CFStringCreateWithCString (Steinberg::kCFAllocator, "", encoding); +} + +//----------------------------------------------------------------------------- +static bool fromCFStringRef (Steinberg::char8* dest, Steinberg::int32 destSize, const void* cfStr, Steinberg::uint32 encoding) +{ + CFIndex usedBytes; + CFRange range = {0, CFStringGetLength ((CFStringRef)cfStr)}; + bool result = CFStringGetBytes ((CFStringRef)cfStr, range, encoding, '?', false, (UInt8*)dest, destSize, &usedBytes); + dest[usedBytes] = 0; + return result; +} +#endif // MAC + +#if WINDOWS +#define stricmp16 wcsicmp +#define strnicmp16 wcsnicmp +#define strrchr16 wcsrchr +#define sprintf16 swprintf +#define snprintf16 snwprintf +#define vsnprintf16 vsnwprintf +#define vsprintf16 wvsprintf +#define vfprintf16 vfwprintf +#define sscanf16 swscanf +#define toupper16 towupper +#define tolower16 towlower +#define isupper16 iswupper +#define islower16 iswlower +#define isspace16 iswspace +#define isalpha16 iswalpha +#define isdigit16 iswdigit +#define isalnum16 iswalnum + +#define stricmp _stricmp +#define strnicmp _strnicmp +#define snprintf _snprintf +#define vsnprintf _vsnprintf +#define snwprintf _snwprintf +#define vsnwprintf _vsnwprintf + +#define wtoi _wtoi +#define wtol _wtol +#define wtof _wtof + +#elif LINUX +#include +#include +#include +#include +#include +#include +#include + +using ConverterFacet = std::codecvt_utf8_utf16; +using Converter = std::wstring_convert; + +//------------------------------------------------------------------------ +static ConverterFacet& converterFacet () +{ + static ConverterFacet gFacet; + return gFacet; +} + +//------------------------------------------------------------------------ +static Converter& converter () +{ + static Converter gConverter; + return gConverter; +} + +//----------------------------------------------------------------------------- +static inline int stricasecmp (const Steinberg::char8* s1, const Steinberg::char8* s2) +{ + return ::strcasecmp (s1, s2); +} + +//----------------------------------------------------------------------------- +static inline int strnicasecmp (const Steinberg::char8* s1, const Steinberg::char8* s2, size_t n) +{ + return ::strncasecmp (s1, s2, n); +} + +//----------------------------------------------------------------------------- +static inline int stricmp16 (const Steinberg::char16* s1, const Steinberg::char16* s2) +{ + auto str1 = converter ().to_bytes (s1); + auto str2 = converter ().to_bytes (s2); + return stricasecmp (str1.data (), str2.data ()); +} + +//----------------------------------------------------------------------------- +static inline int strnicmp16 (const Steinberg::char16* s1, const Steinberg::char16* s2, int n) +{ + auto str1 = converter ().to_bytes (s1); + auto str2 = converter ().to_bytes (s2); + return strnicasecmp (str1.data (), str2.data (), n); +} + +//----------------------------------------------------------------------------- +static inline int sprintf16 (Steinberg::char16* wcs, const Steinberg::char16* format, ...) +{ +#warning DEPRECATED No Linux implementation + assert(false && "DEPRECATED No Linux implementation"); + return 0; +} + +//----------------------------------------------------------------------------- +static inline int vsnwprintf (Steinberg::char16* wcs, size_t maxlen, + const Steinberg::char16* format, va_list args) +{ + Steinberg::char8 str8[kPrintfBufferSize]; + auto format_utf8 = converter ().to_bytes(format); + auto len = vsnprintf (str8, kPrintfBufferSize, format_utf8.data (), args); + + auto tmp_str = converter ().from_bytes (str8, str8 + len); + auto target_len = std::min (tmp_str.size (), maxlen - 1); + tmp_str.copy (wcs, target_len); + wcs[target_len] = '\0'; + + return tmp_str.size (); +} + +//----------------------------------------------------------------------------- +static inline Steinberg::char16* strrchr16 (const Steinberg::char16* str, Steinberg::char16 c) +{ +#warning DEPRECATED No Linux implementation + assert(false && "DEPRECATED No Linux implementation"); + return nullptr; +} + +#elif MAC +#define tstrtoi64 strtoll +#define stricmp strcasecmp +#define strnicmp strncasecmp + +//----------------------------------------------------------------------------- +static inline Steinberg::int32 strnicmp16 (const Steinberg::char16* str1, const Steinberg::char16* str2, size_t size) +{ + if (size == 0) + return 0; + + CFIndex str1Len = Steinberg::strlen16 (str1); + CFIndex str2Len = Steinberg::strlen16 (str2); + if (size < str2Len) // range is not applied to second string + str2Len = size; + CFStringRef cfStr1 = CFStringCreateWithCharactersNoCopy (Steinberg::kCFAllocator, (UniChar*)str1, str1Len, kCFAllocatorNull); + CFStringRef cfStr2 = CFStringCreateWithCharactersNoCopy (Steinberg::kCFAllocator, (UniChar*)str2, str2Len, kCFAllocatorNull); + CFComparisonResult result = CFStringCompareWithOptions (cfStr1, cfStr2, CFRangeMake (0, size), kCFCompareCaseInsensitive); + CFRelease (cfStr1); + CFRelease (cfStr2); + switch (result) + { + case kCFCompareEqualTo: return 0; + case kCFCompareLessThan: return -1; + case kCFCompareGreaterThan: + default: return 1; + }; +} + +//----------------------------------------------------------------------------- +static inline Steinberg::int32 stricmp16 (const Steinberg::char16* str1, CFIndex str1Len, const Steinberg::char16* str2, CFIndex str2Len) +{ + CFStringRef cfStr1 = CFStringCreateWithCharactersNoCopy (Steinberg::kCFAllocator, (UniChar*)str1, str1Len, kCFAllocatorNull); + CFStringRef cfStr2 = CFStringCreateWithCharactersNoCopy (Steinberg::kCFAllocator, (UniChar*)str2, str2Len, kCFAllocatorNull); + CFComparisonResult result = CFStringCompare (cfStr1, cfStr2, kCFCompareCaseInsensitive); + CFRelease (cfStr1); + CFRelease (cfStr2); + switch (result) + { + case kCFCompareEqualTo: return 0; + case kCFCompareLessThan: return -1; + case kCFCompareGreaterThan: + default: return 1; + }; +} + +//----------------------------------------------------------------------------- +static inline Steinberg::int32 stricmp16 (const Steinberg::ConstString& str1, const Steinberg::ConstString& str2) +{ + return stricmp16 (str1.text16 (), str1.length (), str2.text16 (), str2.length ()); +} + +//----------------------------------------------------------------------------- +static inline Steinberg::int32 stricmp16 (const Steinberg::char16* str1, const Steinberg::char16* str2) +{ + CFIndex str1Len = Steinberg::strlen16 (str1); + CFIndex str2Len = Steinberg::strlen16 (str2); + return stricmp16 (str1, str1Len, str2, str2Len); +} + +//----------------------------------------------------------------------------- +static inline Steinberg::char16* strrchr16 (const Steinberg::char16* str, Steinberg::char16 c) +{ + Steinberg::int32 len = Steinberg::ConstString (str).length (); + while (len > 0) + { + if (str[len] == c) + return const_cast(str + len); + len--; + } + return 0; +} + +//----------------------------------------------------------------------------- +static inline Steinberg::int32 vsnwprintf (Steinberg::char16* str, Steinberg::int32 size, const Steinberg::char16* format, va_list ap) +{ + // wrapped using CoreFoundation's CFString + CFMutableStringRef formatString = (CFMutableStringRef)Steinberg::ConstString (format).toCFStringRef (0xFFFF, true); + CFStringFindAndReplace (formatString, CFSTR("%s"), CFSTR("%S"), CFRangeMake (0, CFStringGetLength (formatString)), 0); + CFStringRef resultString = CFStringCreateWithFormatAndArguments (Steinberg::kCFAllocator, 0, formatString, ap); + CFRelease (formatString); + if (resultString) + { + Steinberg::String res; + res.fromCFStringRef (resultString); + res.copyTo16 (str, 0, size); + CFRelease (resultString); + return 0; + } + return 1; +} + +//----------------------------------------------------------------------------- +static inline Steinberg::int32 sprintf16 (Steinberg::char16* str, const Steinberg::char16* format, ...) +{ + va_list marker; + va_start (marker, format); + return vsnwprintf (str, -1, format, marker); +} + +#endif + +/* +UTF-8 EF BB BF +UTF-16 Big Endian FE FF +UTF-16 Little Endian FF FE +UTF-32 Big Endian 00 00 FE FF +UTF-32 Little Endian FF FE 00 00 +*/ + +namespace Steinberg { + +//----------------------------------------------------------------------------- +static inline bool isCaseSensitive (ConstString::CompareMode mode) +{ + return mode == ConstString::kCaseSensitive; +} + +//----------------------------------------------------------------------------- +// ConstString +//----------------------------------------------------------------------------- +ConstString::ConstString (const char8* str, int32 length) +: buffer8 ((char8*)str) +, len (length < 0 ? (str ? static_cast (strlen (str)) : 0) : length) +, isWide (0) +{ +} + +//----------------------------------------------------------------------------- +ConstString::ConstString (const char16* str, int32 length) +: buffer16 ((char16*)str) +, len (length < 0 ? (str ? strlen16 (str) : 0) : length) +, isWide (1) +{ +} + +//----------------------------------------------------------------------------- +ConstString::ConstString (const ConstString& str, int32 offset, int32 length) +: buffer (str.buffer) +, len (length < 0 ? (str.len - (offset > 0 ? offset : 0)) : length) +, isWide (str.isWide) +{ + if (offset > 0) + { + if (isWide) + buffer16 += offset; + else + buffer8 += offset; + } +} + +//----------------------------------------------------------------------------- +ConstString::ConstString (const FVariant& var) +: buffer (0) +, len (0) +, isWide (0) +{ + switch (var.getType ()) + { + case FVariant::kString8: + buffer8 = (char8*)var.getString8 (); + len = buffer8 ? strlen8 (buffer8) : 0; + isWide = false; + break; + + case FVariant::kString16: + buffer16 = (char16*)var.getString16 (); + len = buffer16 ? strlen16 (buffer16) : 0; + isWide = true; + break; + } +} + +//----------------------------------------------------------------------------- +ConstString::ConstString () +: buffer (0) +, len (0) +, isWide (0) +{ +} + +//----------------------------------------------------------------------------- +bool ConstString::testChar8 (uint32 index, char8 c) const +{ + if (index >= len) + return c == 0; + if (isWide) + { + // make c wide + char8 src[] = {c, 0}; + char16 dest[2] = {0}; + if (multiByteToWideString (dest, src, 2) > 0) + return buffer16[index] == dest[0]; + return false; + } + return buffer8[index] == c; +} + +//----------------------------------------------------------------------------- +bool ConstString::testChar16 (uint32 index, char16 c) const +{ + if (index >= len) + return c == 0; + if (!isWide) + { + // make c ansi + char16 src[] = {c, 0}; + char8 dest[8] = {0}; + if (wideStringToMultiByte (dest, src, 2) > 0 && dest[1] == 0) + return buffer8[index] == dest[0]; + return false; + } + return buffer16[index] == c; +} + +//----------------------------------------------------------------------------- +bool ConstString::extract (String& result, uint32 idx, int32 n) const +{ + if (len == 0|| idx >= len) + return false; + + if ((idx + n > len) || n < 0) + n = len - idx; + + if (isWide) + result.assign (buffer16 + idx, n); + else + result.assign (buffer8 + idx, n); + + return true; +} + +//----------------------------------------------------------------------------- +int32 ConstString::copyTo8 (char8* str, uint32 idx, int32 n) const +{ + if (!str) + return 0; + + if (isWide) + { + String tmp (text16 ()); + if (tmp.toMultiByte () == false) + return 0; + return tmp.copyTo8 (str, idx, n); + } + + if (isEmpty () || idx >= len || !buffer8) + { + str[0] = 0; + return 0; + } + + if ((idx + n > len) || n < 0) + n = len - idx; + + memcpy (str, &(buffer8[idx]), n * sizeof (char8)); + str[n] = 0; + return n; +} + +//----------------------------------------------------------------------------- +int32 ConstString::copyTo16 (char16* str, uint32 idx, int32 n) const +{ + if (!str) + return 0; + + if (!isWide) + { + String tmp (text8 ()); + if (tmp.toWideString () == false) + return 0; + return tmp.copyTo16 (str, idx, n); + } + + if (isEmpty () || idx >= len || !buffer16) + { + str[0] = 0; + return 0; + } + + if ((idx + n > len) || n < 0) + n = len - idx; + + memcpy (str, &(buffer16[idx]), n * sizeof (char16)); + str[n] = 0; + return n; +} + +//----------------------------------------------------------------------------- +int32 ConstString::copyTo (tchar* str, uint32 idx, int32 n) const +{ +#ifdef UNICODE + return copyTo16 (str, idx, n); +#else + return copyTo8 (str, idx, n); +#endif +} + +//----------------------------------------------------------------------------- +void ConstString::copyTo (IStringResult* result) const +{ + if (isWideString () == false) + { + result->setText (text8 ()); + } + else + { + FUnknownPtr iStr (result); + if (iStr) + { + iStr->setText16 (text16 ()); + } + else + { + String tmp (*this); + tmp.toMultiByte (); + result->setText (tmp.text8 ()); + } + } +} + +//----------------------------------------------------------------------------- +void ConstString::copyTo (IString& string) const +{ + if (isWideString ()) + string.setText16 (text16 ()); + else + string.setText8 (text8 ()); +} + + + +//----------------------------------------------------------------------------- +int32 ConstString::compare (const ConstString& str, int32 n, CompareMode mode) const +{ + if (n == 0) + return 0; + + if (str.isEmpty ()) + { + if (isEmpty ()) + return 0; + return 1; + } + else if (isEmpty ()) + return -1; + + if (!isWide && !str.isWide) + { + if (n < 0) + { + if (isCaseSensitive (mode)) + return strcmp (*this, str); + else + return stricmp (*this, str); + } + else + { + if (isCaseSensitive (mode)) + return strncmp (*this, str, n); + else + return strnicmp (*this, str, n); + } + } + else if (isWide && str.isWide) + { + if (n < 0) + { + if (isCaseSensitive (mode)) + return strcmp16 (*this, str); + else + return stricmp16 (*this, str); + } + else + { + if (isCaseSensitive (mode)) + return strncmp16 (*this, str, n); + else + return strnicmp16 (*this, str, n); + } + } + return compareAt (0, str, n, mode); +} + +//----------------------------------------------------------------------------- +int32 ConstString::compare (const ConstString& str, CompareMode mode) const +{ + return compare (str, -1, mode); +} + +//----------------------------------------------------------------------------- +int32 ConstString::compareAt (uint32 index, const ConstString& str, int32 n, CompareMode mode) const +{ + if (n == 0) + return 0; + + if (str.isEmpty ()) + { + if (isEmpty ()) + return 0; + return 1; + } + else if (isEmpty ()) + return -1; + + if (!isWide && !str.isWide) + { + char8* toCompare = buffer8; + if (index > 0) + { + if (index >= len) + { + if (str.isEmpty ()) + return 0; + return -1; + } + toCompare += index; + } + + if (n < 0) + { + if (isCaseSensitive (mode)) + return strcmp (toCompare, str); + else + return stricmp (toCompare, str); + } + else + { + if (isCaseSensitive (mode)) + return strncmp (toCompare, str, n); + else + return strnicmp (toCompare, str, n); + } + + return 0; + } + else if (isWide && str.isWide) + { + char16* toCompare = buffer16; + if (index > 0) + { + if (index >= len) + { + if (str.isEmpty ()) + return 0; + return -1; + } + toCompare += index; + } + + if (n < 0) + { + if (isCaseSensitive (mode)) + return strcmp16 (toCompare, str.text16 ()); + else + return stricmp16 (toCompare, str.text16 ()); + } + else + { + if (isCaseSensitive (mode)) + return strncmp16 (toCompare, str.text16 (), n); + else + return strnicmp16 (toCompare, str.text16 (), n); + } + + return 0; + } + else + { + if (isWide) + { + String tmp (str.text8 ()); + if (tmp.toWideString () == false) + return -1; + return compareAt (index, tmp, n, mode); + } + else + { + String tmp (text8 ()); + if (tmp.toWideString () == false) + return 1; + return tmp.compareAt (index, str, n, mode); + } + } + return 0; // should never be reached +} + +//------------------------------------------------------------------------ +Steinberg::int32 ConstString::naturalCompare (const ConstString& str, CompareMode mode /*= kCaseSensitive*/) const +{ + if (str.isEmpty ()) + { + if (isEmpty ()) + return 0; + return 1; + } + else if (isEmpty ()) + return -1; + + if (!isWide && !str.isWide) + return strnatcmp8 (buffer8, str.text8 (), isCaseSensitive (mode)); + else if (isWide && str.isWide) + return strnatcmp16 (buffer16, str.text16 (), isCaseSensitive (mode)); + else + { + if (isWide) + { + String tmp (str.text8 ()); + tmp.toWideString (); + return strnatcmp16 (buffer16, tmp.text16 (), isCaseSensitive (mode)); + } + else + { + String tmp (text8 ()); + tmp.toWideString (); + return strnatcmp16 (tmp.text16 (), str.text16 (), isCaseSensitive (mode)); + } + } + return 0; // should never be reached +} + +//----------------------------------------------------------------------------- +bool ConstString::startsWith (const ConstString& str, CompareMode mode /*= kCaseSensitive*/) const +{ + if (str.isEmpty ()) + { + return isEmpty (); + } + else if (isEmpty ()) + { + return false; + } + if (length () < str.length ()) + { + return false; + } + if (!isWide && !str.isWide) + { + if (isCaseSensitive (mode)) + return strncmp (buffer8, str.buffer8, str.length ()) == 0; + return strnicmp (buffer8, str.buffer8, str.length ()) == 0; + } + else if (isWide && str.isWide) + { + if (isCaseSensitive (mode)) + return strncmp16 (buffer16, str.buffer16, str.length ()) == 0; + return strnicmp16 (buffer16, str.buffer16, str.length ()) == 0; + } + else if (isWide) + { + String tmp (str.text8 ()); + tmp.toWideString (); + if (tmp.length () > length ()) + return false; + if (isCaseSensitive (mode)) + return strncmp16 (buffer16, tmp.buffer16, tmp.length ()) == 0; + return strnicmp16 (buffer16, tmp.buffer16, tmp.length ()) == 0; + } + else + { + String tmp (text8 ()); + tmp.toWideString (); + if (str.length () > tmp.length ()) + return false; + if (isCaseSensitive (mode)) + return strncmp16 (tmp.buffer16, str.buffer16, str.length ()) == 0; + return strnicmp16 (tmp.buffer16, str.buffer16, str.length ()) == 0; + } + ASSERT(false) + return false; // should never be reached +} + +//----------------------------------------------------------------------------- +bool ConstString::endsWith (const ConstString& str, CompareMode mode /*= kCaseSensitive*/) const +{ + if (str.isEmpty ()) + { + return isEmpty (); + } + else if (isEmpty ()) + { + return false; + } + if (length () < str.length ()) + { + return false; + } + if (!isWide && !str.isWide) + { + if (isCaseSensitive (mode)) + return strncmp (buffer8 + (length () - str.length ()), str.buffer8, str.length ()) == 0; + return strnicmp (buffer8 + (length () - str.length ()), str.buffer8, str.length ()) == 0; + } + else if (isWide && str.isWide) + { + if (isCaseSensitive (mode)) + return strncmp16 (buffer16 + (length () - str.length ()), str.buffer16, str.length ()) == 0; + return strnicmp16 (buffer16 + (length () - str.length ()), str.buffer16, str.length ()) == 0; + } + else if (isWide) + { + String tmp (str.text8 ()); + tmp.toWideString (); + if (tmp.length () > length ()) + return false; + if (isCaseSensitive (mode)) + return strncmp16 (buffer16 + (length () - tmp.length ()), tmp.buffer16, tmp.length ()) == 0; + return strnicmp16 (buffer16 + (length () - tmp.length ()), tmp.buffer16, tmp.length ()) == 0; + } + else + { + String tmp (text8 ()); + tmp.toWideString (); + if (str.length () > tmp.length ()) + return false; + if (isCaseSensitive (mode)) + return strncmp16 (tmp.buffer16 + (tmp.length () - str.length ()), str.buffer16, str.length ()) == 0; + return strnicmp16 (tmp.buffer16 + (tmp.length () - str.length ()), str.buffer16, str.length ()) == 0; + } + ASSERT(false) + return false; // should never be reached +} + +//----------------------------------------------------------------------------- +bool ConstString::contains (const ConstString& str, CompareMode m) const +{ + return findFirst (str, -1, m) != -1; +} + +//----------------------------------------------------------------------------- +int32 ConstString::findNext (int32 startIndex, const ConstString& str, int32 n, CompareMode mode, int32 endIndex) const +{ + uint32 endLength = len; + if (endIndex > -1 && (uint32)endIndex < len) + endLength = endIndex + 1; + + if (isWide && str.isWide) + { + if (startIndex < 0) + startIndex = 0; + + uint32 stringLength = str.length (); + n = n < 0 ? stringLength : Min (n, stringLength); + + if (n > 0) + { + uint32 i = 0; + + if (isCaseSensitive (mode)) + { + for (i = startIndex; i < endLength; i++) + if (strncmp16 (buffer16 + i, str, n) == 0) + return i; + } + else + { + for (i = startIndex; i < endLength; i++) + if (strnicmp16 (buffer16 + i, str, n) == 0) + return i; + } + } + return -1; + } + else if (!isWide && !str.isWide) + { + uint32 stringLength = str.length (); + n = n < 0 ? stringLength : Min (n, stringLength); + + if (startIndex < 0) + startIndex = 0; + + if (n > 0) + { + uint32 i = 0; + + if (isCaseSensitive (mode)) + { + for (i = startIndex; i < endLength; i++) + if (strncmp (buffer8 + i, str, n) == 0) + return i; + } + else + { + for (i = startIndex; i < endLength; i++) + if (strnicmp (buffer8 + i, str, n) == 0) + return i; + } + } + return -1; + } + String tmp; + if (isWide) + { + tmp = str.text8 (); + tmp.toWideString (); + return findNext (startIndex, tmp, n , mode, endIndex); + } + tmp = text8 (); + tmp.toWideString (); + return tmp.findNext (startIndex, str, n, mode, endIndex); +} + +//------------------------------------------------------------------------------------------------ +int32 ConstString::findNext (int32 startIndex, char8 c, CompareMode mode, int32 endIndex) const +{ + uint32 endLength = len; + if (endIndex > -1 && (uint32)endIndex < len) + endLength = endIndex + 1; + + if (isWide) + { + char8 src[] = {c, 0}; + char16 dest[8] = {0}; + if (multiByteToWideString (dest, src, 2) > 0) + return findNext (startIndex, dest[0], mode, endIndex); + return -1; + } + + if (startIndex < 0) + startIndex = 0; + uint32 i; + + if (isCaseSensitive (mode)) + { + for (i = startIndex; i < endLength; i++) + { + if (buffer8[i] == c) + return i; + } + } + else + { + c = toLower (c); + for (i = startIndex; i < endLength; i++) + { + if (toLower (buffer8[i]) == c) + return i; + } + } + return -1; +} + +//----------------------------------------------------------------------------- +int32 ConstString::findNext (int32 startIndex, char16 c, CompareMode mode, int32 endIndex) const +{ + uint32 endLength = len; + if (endIndex > -1 && (uint32)endIndex < len) + endLength = endIndex + 1; + + if (!isWide) + { + char16 src[] = {c, 0}; + char8 dest[8] = {0}; + if (wideStringToMultiByte (dest, src, 2) > 0 && dest[1] == 0) + return findNext (startIndex, dest[0], mode, endIndex); + + return -1; + } + + uint32 i; + if (startIndex < 0) + startIndex = 0; + + if (isCaseSensitive (mode)) + { + for (i = startIndex; i < endLength; i++) + { + if (buffer16[i] == c) + return i; + } + } + else + { + c = toLower (c); + for (i = startIndex; i < endLength; i++) + { + if (toLower (buffer16[i]) == c) + return i; + } + } + return -1; +} + +//----------------------------------------------------------------------------- +int32 ConstString::findPrev (int32 startIndex, char8 c, CompareMode mode) const +{ + if (len == 0) + return -1; + + if (isWide) + { + char8 src[] = {c, 0}; + char16 dest[8] = {0}; + if (multiByteToWideString (dest, src, 2) > 0) + return findPrev (startIndex, dest[0], mode); + return -1; + } + + if (startIndex < 0 || startIndex > (int32)len) + startIndex = len; + + int32 i; + + if (isCaseSensitive (mode)) + { + for (i = startIndex; i >= 0; i--) + { + if (buffer8[i] == c) + return i; + } + } + else + { + c = toLower (c); + for (i = startIndex; i >= 0; i--) + { + if (toLower (buffer8[i]) == c) + return i; + } + } + return -1; +} + +//----------------------------------------------------------------------------- +int32 ConstString::findPrev (int32 startIndex, char16 c, CompareMode mode) const +{ + if (len == 0) + return -1; + + if (!isWide) + { + char16 src[] = {c, 0}; + char8 dest[8] = {0}; + if (wideStringToMultiByte (dest, src, 2) > 0 && dest[1] == 0) + return findPrev (startIndex, dest[0], mode); + + return -1; + } + + if (startIndex < 0 || startIndex > (int32)len) + startIndex = len; + + int32 i; + + if (isCaseSensitive (mode)) + { + for (i = startIndex; i >= 0; i--) + { + if (buffer16[i] == c) + return i; + } + } + else + { + c = toLower (c); + for (i = startIndex; i >= 0; i--) + { + if (toLower (buffer16[i]) == c) + return i; + } + } + return -1; +} + +//----------------------------------------------------------------------------- +int32 ConstString::findPrev (int32 startIndex, const ConstString& str, int32 n, CompareMode mode) const +{ + if (isWide && str.isWide) + { + uint32 stringLength = str.length (); + n = n < 0 ? stringLength : Min (n, stringLength); + + if (startIndex < 0 || startIndex >= (int32)len) + startIndex = len - 1; + + if (n > 0) + { + int32 i = 0; + + if (isCaseSensitive (mode)) + { + for (i = startIndex; i >= 0; i--) + if (strncmp16 (buffer16 + i, str, n) == 0) + return i; + } + else + { + for (i = startIndex; i >= 0; i--) + if (strnicmp16 (buffer16 + i, str, n) == 0) + return i; + } + } + return -1; + } + else if (!isWide && !str.isWide) + { + uint32 stringLength = str.length (); + n = n < 0 ? stringLength : Min (n, stringLength); + + if (startIndex < 0 || startIndex >= (int32)len) + startIndex = len - 1; + + if (n > 0) + { + int32 i = 0; + + if (isCaseSensitive (mode)) + { + for (i = startIndex; i >= 0; i--) + if (strncmp (buffer8 + i, str, n) == 0) + return i; + } + else + { + for (i = startIndex; i >= 0; i--) + if (strnicmp (buffer8 + i, str, n) == 0) + return i; + } + } + return -1; + } + if (isWide) + { + String tmp (str.text8 ()); + tmp.toWideString (); + return findPrev (startIndex, tmp, n, mode); + } + String tmp (text8 ()); + tmp.toWideString (); + return tmp.findPrev (startIndex, str, n, mode); +} + +//----------------------------------------------------------------------------- +int32 ConstString::countOccurences (char8 c, uint32 startIndex, CompareMode mode) const +{ + if (isWide) + { + char8 src[] = {c, 0}; + char16 dest[8] = {0}; + if (multiByteToWideString (dest, src, 2) > 0) + return countOccurences (dest[0], startIndex, mode); + return -1; + } + + int32 result = 0; + int32 next = startIndex; + while (true) + { + next = findNext (next, c, mode); + if (next >= 0) + { + next++; + result++; + } + else + break; + } + return result; +} + +//----------------------------------------------------------------------------- +int32 ConstString::countOccurences (char16 c, uint32 startIndex, CompareMode mode) const +{ + if (!isWide) + { + char16 src[] = {c, 0}; + char8 dest[8] = {0}; + if (wideStringToMultiByte (dest, src, 2) > 0 && dest[1] == 0) + return countOccurences (dest[0], startIndex, mode); + + return -1; + } + int32 result = 0; + int32 next = startIndex; + while (true) + { + next = findNext (next, c, mode); + if (next >= 0) + { + next++; + result++; + } + else + break; + } + return result; +} + +//----------------------------------------------------------------------------- +int32 ConstString::getFirstDifferent (const ConstString& str, CompareMode mode) const +{ + if (str.isWide != isWide) + { + if (isWide) + { + String tmp (str.text8 ()); + if (tmp.toWideString () == false) + return -1; + return getFirstDifferent (tmp, mode); + } + else + { + String tmp (text8 ()); + if (tmp.toWideString () == false) + return -1; + return tmp.getFirstDifferent (str, mode); + } + } + + uint32 len1 = len; + uint32 len2 = str.len; + uint32 i; + + if (isWide) + { + if (isCaseSensitive (mode)) + { + for (i = 0; i <= len1 && i <= len2; i++) + { + if (buffer16[i] != str.buffer16[i]) + return i; + } + } + else + { + for (i = 0; i <= len1 && i <= len2; i++) + { + if (toLower (buffer16[i]) != toLower (str.buffer16[i])) + return i; + } + } + } + else + { + if (isCaseSensitive (mode)) + { + for (i = 0; i <= len1 && i <= len2; i++) + { + if (buffer8[i] != str.buffer8[i]) + return i; + } + } + else + { + for (i = 0; i <= len1 && i <= len2; i++) + { + if (toLower (buffer8[i]) != toLower (str.buffer8[i])) + return i; + } + } + } + return -1; +} + +//----------------------------------------------------------------------------- +bool ConstString::scanInt64 (int64& value, uint32 offset, bool scanToEnd) const +{ + if (isEmpty () || offset >= len) + return false; + + if (isWide) + return scanInt64_16 (buffer16 + offset, value, scanToEnd); + else + return scanInt64_8 (buffer8 + offset, value, scanToEnd); +} + +//----------------------------------------------------------------------------- +bool ConstString::scanUInt64 (uint64& value, uint32 offset, bool scanToEnd) const +{ + if (isEmpty () || offset >= len) + return false; + + if (isWide) + return scanUInt64_16 (buffer16 + offset, value, scanToEnd); + else + return scanUInt64_8 (buffer8 + offset, value, scanToEnd); +} + +//----------------------------------------------------------------------------- +bool ConstString::scanHex (uint8& value, uint32 offset, bool scanToEnd) const +{ + if (isEmpty () || offset >= len) + return false; + + if (isWide) + return scanHex_16 (buffer16 + offset, value, scanToEnd); + else + return scanHex_8 (buffer8 + offset, value, scanToEnd); +} + +//----------------------------------------------------------------------------- +bool ConstString::scanInt32 (int32& value, uint32 offset, bool scanToEnd) const +{ + if (isEmpty () || offset >= len) + return false; + + if (isWide) + return scanInt32_16 (buffer16 + offset, value, scanToEnd); + else + return scanInt32_8 (buffer8 + offset, value, scanToEnd); +} + +//----------------------------------------------------------------------------- +bool ConstString::scanUInt32 (uint32& value, uint32 offset, bool scanToEnd) const +{ + if (isEmpty () || offset >= len) + return false; + + if (isWide) + return scanUInt32_16 (buffer16 + offset, value, scanToEnd); + else + return scanUInt32_8 (buffer8 + offset, value, scanToEnd); +} + +//----------------------------------------------------------------------------- +bool ConstString::scanInt64_8 (const char8* text, int64& value, bool scanToEnd) +{ + while (text && text[0]) + { + if (sscanf (text, "%" FORMAT_INT64A, &value) == 1) + return true; + else if (scanToEnd == false) + return false; + text++; + } + return false; +} + +//----------------------------------------------------------------------------- +bool ConstString::scanInt64_16 (const char16* text, int64& value, bool scanToEnd) +{ + if (text && text[0]) + { + String str (text); + str.toMultiByte (kCP_Default); + return scanInt64_8 (str, value, scanToEnd); + } + return false; +} + +//----------------------------------------------------------------------------- +bool ConstString::scanUInt64_8 (const char8* text, uint64& value, bool scanToEnd) +{ + while (text && text[0]) + { + if (sscanf (text, "%" FORMAT_UINT64A, &value) == 1) + return true; + else if (scanToEnd == false) + return false; + text++; + } + return false; +} + +//----------------------------------------------------------------------------- +bool ConstString::scanUInt64_16 (const char16* text, uint64& value, bool scanToEnd) +{ + if (text && text[0]) + { + String str (text); + str.toMultiByte (kCP_Default); + return scanUInt64_8 (str, value, scanToEnd); + } + return false; +} + +//----------------------------------------------------------------------------- +bool ConstString::scanInt64 (const tchar* text, int64& value, bool scanToEnd) +{ +#ifdef UNICODE + return scanInt64_16 (text, value,scanToEnd); +#else + return scanInt64_8 (text, value, scanToEnd); +#endif +} + +//----------------------------------------------------------------------------- +bool ConstString::scanUInt64 (const tchar* text, uint64& value, bool scanToEnd) +{ +#ifdef UNICODE + return scanUInt64_16 (text, value, scanToEnd); +#else + return scanUInt64_8 (text, value, scanToEnd); +#endif +} + +//----------------------------------------------------------------------------- +bool ConstString::scanHex_8 (const char8* text, uint8& value, bool scanToEnd) +{ + while (text && text[0]) + { + unsigned int v; // scanf expects an unsigned int for %x + if (sscanf (text, "%x", &v) == 1) + { + value = (uint8)v; + return true; + } + else if (scanToEnd == false) + return false; + text++; + } + return false; +} + +//----------------------------------------------------------------------------- +bool ConstString::scanHex_16 (const char16* text, uint8& value, bool scanToEnd) +{ + if (text && text[0]) + { + String str (text); + str.toMultiByte (kCP_Default); // scanf uses default codepage + return scanHex_8 (str, value, scanToEnd); + } + return false; +} + +//----------------------------------------------------------------------------- +bool ConstString::scanHex (const tchar* text, uint8& value, bool scanToEnd) +{ +#ifdef UNICODE + return scanHex_16 (text, value, scanToEnd); +#else + return scanHex_8 (text, value, scanToEnd); +#endif +} + +//----------------------------------------------------------------------------- +bool ConstString::scanFloat (double& value, uint32 offset, bool scanToEnd) const +{ + if (isEmpty () || offset >= len) + return false; + + String str (*this); + int32 pos = -1; + if (isWide) + { + if ((pos = str.findNext (offset, STR(','))) >= 0 && ((uint32)pos) >= offset) + str.setChar (pos, STR('.')); + + str.toMultiByte (kCP_Default); // scanf uses default codepage + } + else + { + if ((pos = str.findNext (offset, ',')) >= 0 && ((uint32)pos) >= offset) + str.setChar (pos, '.'); + } + + const char8* txt = str.text8 () + offset; + while (txt && txt[0]) + { + if (sscanf (txt, "%lf", &value) == 1) + return true; + else if (scanToEnd == false) + return false; + txt++; + } + return false; +} + +//----------------------------------------------------------------------------- +char16 ConstString::toLower (char16 c) +{ + #if WINDOWS + WCHAR temp[2] = {c, 0}; + ::CharLowerW (temp); + return temp[0]; + #elif MAC + // only convert characters which in lowercase are also single characters + UniChar characters [2] = {0}; + characters[0] = c; + CFMutableStringRef str = CFStringCreateMutableWithExternalCharactersNoCopy (kCFAllocator, characters, 1, 2, kCFAllocatorNull); + if (str) + { + CFStringLowercase (str, NULL); + CFRelease (str); + if (characters[1] == 0) + return characters[0]; + } + return c; + #elif LINUX + #warning DEPRECATED No Linux implementation + assert(false && "DEPRECATED No Linux implementation"); + return c; + #else + return towlower (c); + #endif +} + +//----------------------------------------------------------------------------- +char16 ConstString::toUpper (char16 c) +{ + #if WINDOWS + WCHAR temp[2] = {c, 0}; + ::CharUpperW (temp); + return temp[0]; + #elif MAC + // only convert characters which in uppercase are also single characters (don't translate a sharp-s which would result in SS) + UniChar characters [2] = {0}; + characters[0] = c; + CFMutableStringRef str = CFStringCreateMutableWithExternalCharactersNoCopy (kCFAllocator, characters, 1, 2, kCFAllocatorNull); + if (str) + { + CFStringUppercase (str, NULL); + CFRelease (str); + if (characters[1] == 0) + return characters[0]; + } + return c; + #elif LINUX + #warning DEPRECATED No Linux implementation + assert(false && "DEPRECATED No Linux implementation"); + return c; + #else + return towupper (c); + #endif +} + +//----------------------------------------------------------------------------- +char8 ConstString::toLower (char8 c) +{ + if ((c >= 'A') && (c <= 'Z')) + return c + ('a' - 'A'); + #if WINDOWS + CHAR temp[2] = {c, 0}; + ::CharLowerA (temp); + return temp[0]; + #else + return tolower (c); + #endif +} + +//----------------------------------------------------------------------------- +char8 ConstString::toUpper (char8 c) +{ + if ((c >= 'a') && (c <= 'z')) + return c - ('a' - 'A'); + #if WINDOWS + CHAR temp[2] = {c, 0}; + ::CharUpperA (temp); + return temp[0]; + #else + return toupper (c); + #endif +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharSpace (const char8 character) +{ + return isspace (character) != 0; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharSpace (const char16 character) +{ + switch (character) + { + case 0x0020: + case 0x00A0: + case 0x2002: + case 0x2003: + case 0x2004: + case 0x2005: + case 0x2006: + case 0x2007: + case 0x2008: + case 0x2009: + case 0x200A: + case 0x200B: + case 0x202F: + case 0x205F: + case 0x3000: + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharAlpha (const char8 character) +{ + return isalpha (character) != 0; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharAlpha (const char16 character) +{ + return iswalpha (character) != 0; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharAlphaNum (const char8 character) +{ + return isalnum (character) != 0; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharAlphaNum (const char16 character) +{ + return iswalnum (character) != 0; // this may not work on MacOSX when another locale is set inside the c-lib +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharDigit (const char8 character) +{ + return isdigit (character) != 0; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharDigit (const char16 character) +{ + return iswdigit (character) != 0; // this may not work on MacOSX when another locale is set inside the c-lib +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharAscii (char8 character) +{ + return character >= 0; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharAscii (char16 character) +{ + return character < 128; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharUpper (char8 character) +{ + return toUpper (character) == character; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharUpper (char16 character) +{ + return toUpper (character) == character; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharLower (char8 character) +{ + return toLower (character) == character; +} + +//----------------------------------------------------------------------------- +bool ConstString::isCharLower (char16 character) +{ + return toLower (character) == character; +} + +//----------------------------------------------------------------------------- +bool ConstString::isDigit (uint32 index) const +{ + if (isEmpty () || index >= len) + return false; + + if (isWide) + return ConstString::isCharDigit (buffer16[index]); + else + return ConstString::isCharDigit (buffer8[index]); +} + +//----------------------------------------------------------------------------- +int32 ConstString::getTrailingNumberIndex (uint32 width) const +{ + if (isEmpty ()) + return -1; + + int32 endIndex = len - 1; + int32 i = endIndex; + while (isDigit ((uint32) i) && i >= 0) + i--; + + // now either all are digits or i is on the first non digit + if (i < endIndex) + { + if (width > 0 && (endIndex - i != width)) + return -1; + + return i + 1; + } + + return -1; +} + +//----------------------------------------------------------------------------- +int64 ConstString::getTrailingNumber (int64 fallback) const +{ + int32 index = getTrailingNumberIndex (); + + int64 number = 0; + + if (index >= 0) + if (scanInt64 (number, index)) + return number; + + return fallback; +} + + + +//----------------------------------------------------------------------------- +void ConstString::toVariant (FVariant& var) const +{ + if (isWide) + { + var.setString16 (buffer16); + } + else + { + var.setString8 (buffer8); + } +} + +//----------------------------------------------------------------------------- +bool ConstString::isAsciiString () const +{ + uint32 i; + if (isWide) + { + for (i = 0; i < len; i++) + if (ConstString::isCharAscii (buffer16 [i]) == false) + return false; + } + else + { + for (i = 0; i < len; i++) + if (ConstString::isCharAscii (buffer8 [i]) == false) + return false; + } + return true; +} + + +#if MAC +uint32 kDefaultSystemEncoding = kCFStringEncodingMacRoman; +//----------------------------------------------------------------------------- +static CFStringEncoding MBCodePageToCFStringEncoding (uint32 codePage) +{ + switch (codePage) + { + case kCP_ANSI: return kDefaultSystemEncoding; // MacRoman or JIS + case kCP_MAC_ROMAN: return kCFStringEncodingMacRoman; + case kCP_ANSI_WEL: return kCFStringEncodingWindowsLatin1; + case kCP_MAC_CEE: return kCFStringEncodingMacCentralEurRoman; + case kCP_Utf8: return kCFStringEncodingUTF8; + case kCP_ShiftJIS: return kCFStringEncodingShiftJIS_X0213_00; + case kCP_US_ASCII: return kCFStringEncodingASCII; + } + return kCFStringEncodingASCII; +} +#endif + +//----------------------------------------------------------------------------- +int32 ConstString::multiByteToWideString (char16* dest, const char8* source, int32 charCount, uint32 sourceCodePage) +{ + if (source == 0 || source[0] == 0) + { + if (dest && charCount > 0) + { + dest[0] = 0; + } + return 0; + } + int32 result = 0; +#if WINDOWS + result = MultiByteToWideChar (sourceCodePage, MB_ERR_INVALID_CHARS, source, -1, dest, charCount); +#endif + +#if MAC + CFStringRef cfStr = (CFStringRef)::toCFStringRef (source, MBCodePageToCFStringEncoding (sourceCodePage)); + if (cfStr) + { + CFRange range = {0, CFStringGetLength (cfStr)}; + CFIndex usedBytes; + if (CFStringGetBytes (cfStr, range, kCFStringEncodingUnicode, ' ', false, (UInt8*)dest, charCount * 2, &usedBytes) > 0) + { + result = static_cast(usedBytes/2 + 1); + if (dest) + dest[usedBytes/2] = 0; + } + + CFRelease (cfStr); + } +#endif + +#if LINUX + if (sourceCodePage == kCP_ANSI || sourceCodePage == kCP_Utf8) + { + if (dest == nullptr) + { + auto state = std::mbstate_t (); + auto maxChars = charCount ? charCount : std::numeric_limits::max () - 1; + result = converterFacet ().length (state, source, source + strlen (source), maxChars); + } + else + { + auto utf16Str = converter ().from_bytes (source); + if (!utf16Str.empty ()) + { + result = std::min (charCount, utf16Str.size ()); + memcpy (dest, utf16Str.data (), result * sizeof (char16)); + dest[result] = 0; + } + } + } + else + { +#warning DEPRECATED No Linux implementation + assert(false && "DEPRECATED No Linux implementation"); + } + +#endif + + ASSERT (result > 0) + return result; +} + +//----------------------------------------------------------------------------- +int32 ConstString::wideStringToMultiByte (char8* dest, const char16* wideString, int32 charCount, uint32 destCodePage) +{ +#if WINDOWS + return WideCharToMultiByte (destCodePage, 0, wideString, -1, dest, charCount, 0, 0); + +#elif MAC + int32 result = 0; + if (wideString != 0) + { + if (dest) + { + CFStringRef cfStr = CFStringCreateWithCharactersNoCopy (kCFAllocator, (const UniChar*)wideString, strlen16 (wideString), kCFAllocatorNull); + if (cfStr) + { + if (fromCFStringRef (dest, charCount, cfStr, MBCodePageToCFStringEncoding (destCodePage))) + result = static_cast(strlen (dest) + 1); + CFRelease (cfStr); + } + } + else + { + return static_cast(CFStringGetMaximumSizeForEncoding (strlen16 (wideString), MBCodePageToCFStringEncoding (destCodePage))); + } + } + return result; + +#elif LINUX + int32 result = 0; + if (destCodePage == kCP_Utf8) + { + if (dest == nullptr) + { + auto maxChars = charCount ? charCount : tstrlen (wideString); + result = converterFacet ().max_length () * maxChars; + } + else + { + auto utf8Str = converter ().to_bytes (wideString); + if (!utf8Str.empty ()) + { + result = std::min (charCount, utf8Str.size ()); + memcpy (dest, utf8Str.data (), result * sizeof (char8)); + dest[result] = 0; + } + } + } + else if (destCodePage == kCP_ANSI) + { + if (dest == nullptr) + { + result = strlen16 (wideString) + 1; + } + else + { + int32 i = 0; + for (; i < charCount; ++i) + { + if (wideString[i] == 0) + break; + if (wideString[i] <= 0x007F) + dest[i] = wideString[i]; + else + dest[i] = '_'; + } + dest[i] = 0; + result = i; + } + } + else + { +#warning DEPRECATED No Linux implementation + assert(false && "DEPRECATED No Linux implementation"); + } + return result; + +#else +#warning DEPRECATED No Linux implementation + assert(false && "DEPRECATED No Linux implementation"); + return 0; +#endif + +} + +//----------------------------------------------------------------------------- +bool ConstString::isNormalized (UnicodeNormalization n) +{ + if (isWide == false) + return false; + +#if WINDOWS +#ifdef UNICODE + if (n != kUnicodeNormC) + return false; + int32 normCharCount = FoldString (MAP_PRECOMPOSED, buffer16, len, 0, 0); + return (normCharCount == len); +#endif + +#elif MAC + if (n != kUnicodeNormC) + return false; + + CFStringRef cfStr = (CFStringRef)toCFStringRef (); + CFIndex charCount = CFStringGetLength (cfStr); + CFRelease (cfStr); + return (charCount == len); + +#endif + + return false; +} + +//----------------------------------------------------------------------------- +// String +//----------------------------------------------------------------------------- +String::String () +{ + isWide = kWideStringDefault ? 1 : 0; +} + +//----------------------------------------------------------------------------- +String::String (const char8* str, MBCodePage codePage, int32 n, bool isTerminated) +{ + isWide = 0; + if (str) + { + assign (str, n, isTerminated); + toWideString (codePage); + } +} + +//----------------------------------------------------------------------------- +String::String (const char8* str, int32 n, bool isTerminated) +{ + if (str) + assign (str, n, isTerminated); +} + +//----------------------------------------------------------------------------- +String::String (const char16* str, int32 n, bool isTerminated) +{ + isWide = 1; + if (str) + assign (str, n, isTerminated); +} + +//----------------------------------------------------------------------------- +String::String (const String& str, int32 n) +{ + isWide = str.isWideString (); + if (!str.isEmpty ()) + assign (str, n); +} + +//----------------------------------------------------------------------------- +String::String (const ConstString& str, int32 n) +{ + isWide = str.isWideString (); + if (!str.isEmpty ()) + assign (str, n); +} + +//----------------------------------------------------------------------------- +String::String (const FVariant& var) +{ + isWide = kWideStringDefault ? 1 : 0; + fromVariant (var); +} + +//----------------------------------------------------------------------------- +String::String (IString* str) +{ + isWide = str->isWideString (); + if (isWide) + assign (str->getText16 ()); + else + assign (str->getText8 ()); +} + +//----------------------------------------------------------------------------- +String::~String () +{ + if (buffer) + resize (0, false); +} + +#if SMTG_CPP11_STDLIBSUPPORT +//----------------------------------------------------------------------------- +String::String (String&& str) +{ + *this = std::move (str); +} + +//----------------------------------------------------------------------------- +String& String::operator= (String&& str) +{ + ASSERT (buffer == 0 || buffer != str.buffer); + tryFreeBuffer (); + + isWide = str.isWide; + buffer = str.buffer; + len = str.len; + str.buffer = nullptr; + str.len = 0; + return *this; +} +#endif + +//----------------------------------------------------------------------------- +void String::updateLength () +{ + if (isWide) + len = strlen16 (text16 ()); + else + len = strlen8 (text8 ()); +} + +//----------------------------------------------------------------------------- +bool String::toWideString (uint32 sourceCodePage) +{ + if (!isWide) + { + if (buffer8 && len > 0) + { + int32 bytesNeeded = multiByteToWideString (0, buffer8, 0, sourceCodePage) * sizeof (char16); + if (bytesNeeded) + { + bytesNeeded += sizeof (char16); + char16* newStr = (char16*) malloc (bytesNeeded); + if (multiByteToWideString (newStr, buffer8, len + 1, sourceCodePage) <= 0) + { + free (newStr); + return false; + } + free (buffer8); + buffer16 = newStr; + isWide = true; + updateLength (); + } + else + { + return false; + } + } + isWide = true; + } + return true; +} + +#define SMTG_STRING_CHECK_CONVERSION 1 +#define SMTG_STRING_CHECK_CONVERSION_NO_BREAK 0 + +#if SMTG_STRING_CHECK_CONVERSION_NO_BREAK + #define SMTG_STRING_CHECK_MSG FDebugPrint +#else + #define SMTG_STRING_CHECK_MSG FDebugBreak +#endif +//----------------------------------------------------------------------------- +bool String::checkToMultiByte (uint32 destCodePage) const +{ + if (!isWide || isEmpty ()) + return true; + +#if DEVELOPMENT && SMTG_STRING_CHECK_CONVERSION + int debugLen = length (); + int debugNonASCII = 0; + for (int32 i = 0; i < length (); i++) + { + if (buffer16[i] > 127) + ++debugNonASCII; + } + + String* backUp = nullptr; + if (debugNonASCII > 0) + backUp = NEW String (*this); +#endif + + // this should be avoided, since it can lead to information loss + bool result = const_cast (*this).toMultiByte (destCodePage); + +#if DEVELOPMENT && SMTG_STRING_CHECK_CONVERSION + if (backUp) + { + String temp (*this); + temp.toWideString (destCodePage); + + if (temp != *backUp) + { + backUp->toMultiByte (kCP_Utf8); + SMTG_STRING_CHECK_MSG ("Indirect string conversion information loss ! %d/%d non ASCII chars: \"%s\" -> \"%s\"\n", debugNonASCII, debugLen, backUp->buffer8, buffer8); + } + else + SMTG_STRING_CHECK_MSG ("Indirect string potential conversion information loss ! %d/%d non ASCII chars result: \"%s\"\n", debugNonASCII, debugLen, buffer8); + + delete backUp; + } +#endif + + return result; +} + +//----------------------------------------------------------------------------- +bool String::toMultiByte (uint32 destCodePage) +{ + if (isWide) + { + if (buffer16 && len > 0) + { + int32 numChars = wideStringToMultiByte (0, buffer16, 0, destCodePage) + sizeof (char8); + char8* newStr = (char8*) malloc (numChars * sizeof (char8)); + if (wideStringToMultiByte (newStr, buffer16, numChars, destCodePage) <= 0) + { + free (newStr); + return false; + } + free (buffer16); + buffer8 = newStr; + isWide = false; + updateLength (); + } + isWide = false; + } + else if (destCodePage != kCP_Default) + { + if (toWideString () == false) + return false; + return toMultiByte (destCodePage); + } + return true; +} + +//----------------------------------------------------------------------------- +void String::fromUTF8 (const char8* utf8String) +{ + assign (utf8String); + toWideString (kCP_Utf8); +} + +//----------------------------------------------------------------------------- +bool String::normalize (UnicodeNormalization n) +{ + if (isWide == false) + return false; + + if (buffer16 == 0) + return true; + +#if WINDOWS +#ifdef UNICODE + if (n != kUnicodeNormC) + return false; + + int32 normCharCount = FoldString (MAP_PRECOMPOSED, buffer16, len, 0, 0); + if (normCharCount == len) + return true; + + char16* newString = (char16*)malloc ((normCharCount + 1) * sizeof (char16)); + int32 converterCount = FoldString (MAP_PRECOMPOSED, buffer16, len, newString, normCharCount + 1); + if (converterCount != normCharCount) + { + free (newString); + return false; + } + newString [converterCount] = 0; + free (buffer16); + buffer16 = newString; + updateLength (); + return true; +#endif + +#elif MAC + CFMutableStringRef origStr = (CFMutableStringRef)toCFStringRef (0xFFFF, true); + if (origStr) + { + CFStringNormalizationForm normForm = kCFStringNormalizationFormD; + switch (n) + { + case kUnicodeNormC: normForm = kCFStringNormalizationFormC; break; + case kUnicodeNormD: normForm = kCFStringNormalizationFormD; break; + case kUnicodeNormKC: normForm = kCFStringNormalizationFormKC; break; + case kUnicodeNormKD: normForm = kCFStringNormalizationFormKD; break; + } + CFStringNormalize (origStr, normForm); + bool result = fromCFStringRef (origStr); + CFRelease (origStr); + return result; + } + +#endif + + return false; +} + +//----------------------------------------------------------------------------- +void String::tryFreeBuffer () +{ + if (buffer) + { + free (buffer); + buffer = 0; + } +} + +//----------------------------------------------------------------------------- +bool String::resize (uint32 newLength, bool wide, bool fill) +{ + if (newLength == 0) + { + tryFreeBuffer (); + len = 0; + isWide = wide ? 1 : 0; + } + else + { + TSize newCharSize = wide ? sizeof (char16) : sizeof (char8); + TSize oldCharSize = (isWide != 0) ? sizeof (char16) : sizeof (char8); + + TSize newBufferSize = (newLength + 1) * newCharSize; + TSize oldBufferSize = (len + 1) * oldCharSize; + + isWide = wide ? 1 : 0; + + if (buffer) + { + if (newBufferSize != oldBufferSize) + { + void* newstr = realloc (buffer, newBufferSize); + if (newstr == 0) + return false; + buffer = newstr; + if (isWide) + buffer16[newLength] = 0; + else + buffer8[newLength] = 0; + } + else if (wide && newCharSize != oldCharSize) + buffer16[newLength] = 0; + } + else + { + void* newstr = malloc (newBufferSize); + if (newstr == 0) + return false; + buffer = newstr; + if (isWide) + { + buffer16[0] = 0; + buffer16[newLength] = 0; + } + else + { + buffer8[0] = 0; + buffer8[newLength] = 0; + } + } + + if (fill && len < newLength && buffer) + { + if (isWide) + { + char16 c = ' '; + for (uint32 i = len; i < newLength; i++) + buffer16 [i] = c; + } + else + { + memset (buffer8 + len, ' ', newLength - len); + } + } + } + return true; +} + +//----------------------------------------------------------------------------- +bool String::setChar8 (uint32 index, char8 c) +{ + if (index == len && c == 0) + return true; + + if (index >= len) + { + if (c == 0) + { + if (resize (index, isWide, true) == false) + return false; + len = index; + return true; + } + else + { + if (resize (index + 1, isWide, true) == false) + return false; + len = index + 1; + } + } + + if (index < len && buffer) + { + if (isWide) + { + if (c == 0) + buffer16[index] = 0; + else + { + char8 src[] = {c, 0}; + char16 dest[8] = {0}; + if (multiByteToWideString (dest, src, 2) > 0) + buffer16[index] = dest[0]; + } + ASSERT (buffer16[len] == 0) + } + else + { + buffer8[index] = c; + ASSERT (buffer8[len] == 0) + } + + if (c == 0) + updateLength (); + + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +bool String::setChar16 (uint32 index, char16 c) +{ + if (index == len && c == 0) + return true; + + if (index >= len) + { + if (c == 0) + { + if (resize (index, isWide, true) == false) + return false; + len = index; + return true; + } + else + { + if (resize (index + 1, isWide, true) == false) + return false; + len = index + 1; + } + } + + if (index < len && buffer) + { + if (isWide) + { + buffer16[index] = c; + ASSERT (buffer16[len] == 0) + } + else + { + ASSERT (buffer8[len] == 0) + char16 src[] = {c, 0}; + char8 dest[8] = {0}; + if (wideStringToMultiByte (dest, src, 2) > 0 && dest[1] == 0) + buffer8[index] = dest[0]; + else + return false; + } + + if (c == 0) + updateLength (); + + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +String& String::assign (const ConstString& str, int32 n) +{ + if (str.isWideString ()) + return assign (str.text16 (), n < 0 ? str.length () : n); + else + return assign (str.text8 (), n < 0 ? str.length () : n); +} + +//----------------------------------------------------------------------------- +String& String::assign (const char8* str, int32 n, bool isTerminated) +{ + if (str == buffer8) + return *this; + + if (isTerminated) + { + uint32 stringLength = (uint32)((str) ? strlen (str) : 0); + n = n < 0 ? stringLength : Min (n, stringLength); + } + else if (n < 0) + return *this; + + if (resize (n, false)) + { + if (buffer8 && n > 0) + { + memcpy (buffer8, str, n * sizeof (char8)); + ASSERT (buffer8[n] == 0) + } + isWide = 0; + len = n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::assign (const char16* str, int32 n, bool isTerminated) +{ + if (str == buffer16) + return *this; + + if (isTerminated) + { + uint32 stringLength = (uint32)((str) ? strlen16 (str) : 0); + n = n < 0 ? stringLength : Min (n, stringLength); + } + else if (n < 0) + return *this; + + if (resize (n, true)) + { + if (buffer16 && n > 0) + { + memcpy (buffer16, str, n * sizeof (char16)); + ASSERT (buffer16[n] == 0) + } + isWide = 1; + len = n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::assign (char8 c, int32 n) +{ + if (resize (n, false)) + { + if (buffer8 && n > 0) + { + memset (buffer8, c, n * sizeof (char8)); + ASSERT (buffer8[n] == 0) + } + isWide = 0; + len = n; + } + return *this; + +} + +//----------------------------------------------------------------------------- +String& String::assign (char16 c, int32 n) +{ + if (resize (n, true)) + { + if (buffer && n > 0) + { + for (int32 i = 0; i < n; i++) + buffer16[i] = c; + ASSERT (buffer16[n] == 0) + } + isWide = 1; + len = n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::append (const ConstString& str, int32 n) +{ + if (str.isWideString ()) + return append (str.text16 (), n); + else + return append (str.text8 (), n); +} + +//----------------------------------------------------------------------------- +String& String::append (const char8* str, int32 n) +{ + if (str == buffer8) + return *this; + + if (len == 0) + return assign (str, n); + + if (isWide) + { + String tmp (str); + if (tmp.toWideString () == false) + return *this; + + return append (tmp.buffer16, n); + } + + uint32 stringLength = (uint32)((str) ? strlen (str) : 0); + n = n < 0 ? stringLength : Min (n, stringLength); + + if (n > 0) + { + int32 newlen = n + len; + if (!resize (newlen, false)) + return *this; + + if (buffer) + { + memcpy (buffer8 + len, str, n * sizeof (char8)); + ASSERT (buffer8[newlen] == 0) + } + + len += n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::append (const char16* str, int32 n) +{ + if (str == buffer16) + return *this; + + if (len == 0) + return assign (str, n); + + if (!isWide) + { + if (toWideString () == false) + return *this; + } + + uint32 stringLength = (uint32)((str) ? strlen16 (str) : 0); + n = n < 0 ? stringLength : Min (n, stringLength); + + if (n > 0) + { + int32 newlen = n + len; + if (!resize (newlen, true)) + return *this; + + if (buffer16) + { + memcpy (buffer16 + len, str, n * sizeof (char16)); + ASSERT (buffer16[newlen] == 0) + } + + len += n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::append (const char8 c, int32 n) +{ + char8 str[] = {c, 0}; + if (n == 1) + { + return append (str, 1); + } + else if (n > 1) + { + if (isWide) + { + String tmp (str); + if (tmp.toWideString () == false) + return *this; + + return append (tmp.buffer16[0], n); + } + + int32 newlen = n + len; + if (!resize (newlen, false)) + return *this; + + if (buffer) + { + memset (buffer8 + len, c, n * sizeof (char8)); + ASSERT (buffer8[newlen] == 0) + } + + len += n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::append (const char16 c, int32 n) +{ + if (n == 1) + { + char16 str[] = {c, 0}; + return append (str, 1); + } + else if (n > 1) + { + if (!isWide) + { + if (toWideString () == false) + return *this; + } + + int32 newlen = n + len; + if (!resize (newlen, true)) + return *this; + + if (buffer16) + { + for (int32 i = len; i < newlen; i++) + buffer16[i] = c; + ASSERT (buffer16[newlen] == 0) + } + + len += n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::insertAt (uint32 idx, const ConstString& str, int32 n) +{ + if (str.isWideString ()) + return insertAt (idx, str.text16 (), n); + else + return insertAt (idx, str.text8 (), n); +} + +//----------------------------------------------------------------------------- +String& String::insertAt (uint32 idx, const char8* str, int32 n) +{ + if (idx > len) + return *this; + + if (isWide) + { + String tmp (str); + if (tmp.toWideString () == false) + return *this; + return insertAt (idx, tmp.buffer16, n); + } + + uint32 stringLength = (uint32)((str) ? strlen (str) : 0); + n = n < 0 ? stringLength : Min (n, stringLength); + + if (n > 0) + { + int32 newlen = len + n; + if (!resize (newlen, false)) + return *this; + + if (buffer) + { + if (idx < len) + memmove (buffer8 + idx + n, buffer8 + idx, (len - idx) * sizeof (char8)); + memcpy (buffer8 + idx, str, n * sizeof (char8)); + ASSERT (buffer8[newlen] == 0) + } + + len += n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::insertAt (uint32 idx, const char16* str, int32 n) +{ + if (idx > len) + return *this; + + if (!isWide) + { + if (toWideString () == false) + return *this; + } + + uint32 stringLength = (uint32)((str) ? strlen16 (str) : 0); + n = n < 0 ? stringLength : Min (n, stringLength); + + if (n > 0) + { + int32 newlen = len + n; + if (!resize (newlen, true)) + return *this; + + if (buffer) + { + if (idx < len) + memmove (buffer16 + idx + n, buffer16 + idx, (len - idx) * sizeof (char16)); + memcpy (buffer16 + idx, str, n * sizeof (char16)); + ASSERT (buffer16[newlen] == 0) + } + + len += n; + } + return *this; +} + +//----------------------------------------------------------------------------- +String& String::replace (uint32 idx, int32 n1, const ConstString& str, int32 n2) +{ + if (str.isWideString ()) + return replace (idx, n1, str.text16 (), n2); + else + return replace (idx, n1, str.text8 (), n2); +} + +// "replace" replaces n1 number of characters at the specified index with +// n2 characters from the specified string. +//----------------------------------------------------------------------------- +String& String::replace (uint32 idx, int32 n1, const char8* str, int32 n2) +{ + if (idx > len || str == 0) + return *this; + + if (isWide) + { + String tmp (str); + if (tmp.toWideString () == false) + return *this; + if (tmp.length () == 0 || n2 == 0) + return remove (idx, n1); + return replace (idx, n1, tmp.buffer16, n2); + } + + if (n1 < 0 || idx + n1 > len) + n1 = len - idx; + if (n1 == 0) + return *this; + + uint32 stringLength = (uint32)((str) ? strlen (str) : 0); + n2 = n2 < 0 ? stringLength : Min (n2, stringLength); + + uint32 newlen = len - n1 + n2; + if (newlen > len) + if (!resize (newlen, false)) + return *this; + + if (buffer) + { + memmove (buffer8 + idx + n2, buffer8 + idx + n1, (len - (idx + n1)) * sizeof (char8)); + memcpy (buffer8 + idx, str, n2 * sizeof (char8)); + buffer8[newlen] = 0; // cannot be removed because resize is not called called in all cases (newlen > len) + } + + len = newlen; + + return *this; +} + +//----------------------------------------------------------------------------- +String& String::replace (uint32 idx, int32 n1, const char16* str, int32 n2) +{ + if (idx > len || str == 0) + return *this; + + if (!isWide) + { + if (toWideString () == false) + return *this; + } + + if (n1 < 0 || idx + n1 > len) + n1 = len - idx; + if (n1 == 0) + return *this; + + uint32 stringLength = (uint32)((str) ? strlen16 (str) : 0); + n2 = n2 < 0 ? stringLength : Min (n2, stringLength); + + uint32 newlen = len - n1 + n2; + if (newlen > len) + if (!resize (newlen, true)) + return *this; + + if (buffer) + { + memmove (buffer16 + idx + n2, buffer16 + idx + n1, (len - (idx + n1)) * sizeof (char16)); + memcpy (buffer16 + idx, str, n2 * sizeof (char16)); + buffer16[newlen] = 0; // cannot be removed because resize is not called called in all cases (newlen > len) + } + + len = newlen; + + return *this; +} + +//----------------------------------------------------------------------------- +int32 String::replace (const char8* toReplace, const char8* toReplaceWith, bool all, CompareMode m) +{ + if (toReplace == 0 || toReplaceWith == 0) + return 0; + + int32 result = 0; + + int32 idx = findFirst (toReplace, -1, m); + if (idx > -1) + { + int32 toReplaceLen = static_cast(strlen (toReplace)); + int32 toReplaceWithLen = static_cast(strlen (toReplaceWith)); + while (idx > -1) + { + replace (idx, toReplaceLen, toReplaceWith, toReplaceWithLen); + result++; + + if (all) + idx = findNext (idx + toReplaceWithLen , toReplace, -1, m); + else + break; + } + } + + return result; +} + +//----------------------------------------------------------------------------- +int32 String::replace (const char16* toReplace, const char16* toReplaceWith, bool all, CompareMode m) +{ + if (toReplace == 0 || toReplaceWith == 0) + return 0; + + int32 result = 0; + + int32 idx = findFirst (toReplace, -1, m); + if (idx > -1) + { + int32 toReplaceLen = strlen16 (toReplace); + int32 toReplaceWithLen = strlen16 (toReplaceWith); + while (idx > -1) + { + replace (idx, toReplaceLen, toReplaceWith, toReplaceWithLen); + result++; + + if (all) + idx = findNext (idx + toReplaceWithLen, toReplace, -1, m); + else + break; + } + } + return result; +} + +//----------------------------------------------------------------------------- +template +static bool performReplace (T* str, const T* toReplace, T toReplaceBy) +{ + bool anyReplace = false; + T* p = str; + while (*p) + { + const T* rep = toReplace; + while (*rep) + { + if (*p == *rep) + { + *p = toReplaceBy; + anyReplace = true; + break; + } + rep++; + } + p++; + } + return anyReplace; +} + +//----------------------------------------------------------------------------- +bool String::replaceChars8 (const char8* toReplace, char8 toReplaceBy) +{ + if (isEmpty ()) + return false; + + if (isWide) + { + String toReplaceW (toReplace); + if (toReplaceW.toWideString () == false) + return false; + + char8 src[] = {toReplaceBy, 0}; + char16 dest[2] = {0}; + if (multiByteToWideString (dest, src, 2) > 0) + { + return replaceChars16 (toReplaceW.text16 (), dest[0]); + } + return false; + } + + if (toReplaceBy == 0) + toReplaceBy = ' '; + + return performReplace (buffer8, toReplace, toReplaceBy); +} + +//----------------------------------------------------------------------------- +bool String::replaceChars16 (const char16* toReplace, char16 toReplaceBy) +{ + if (isEmpty ()) + return false; + + if (!isWide) + { + String toReplaceA (toReplace); + if (toReplaceA.toMultiByte () == false) + return false; + + if (toReplaceA.length () > 1) + { + WARNING("cannot replace non ASCII chars on non Wide String") + return false; + } + + char16 src[] = {toReplaceBy, 0}; + char8 dest[8] = {0}; + if (wideStringToMultiByte (dest, src, 2) > 0 && dest[1] == 0) + return replaceChars8 (toReplaceA.text8 (), dest[0]); + + return false; + } + + if (toReplaceBy == 0) + toReplaceBy = STR16 (' '); + + return performReplace (buffer16, toReplace, toReplaceBy); +} + +// "remove" removes the specified number of characters from the string +// starting at the specified index. +//----------------------------------------------------------------------------- +String& String::remove (uint32 idx, int32 n) +{ + if (isEmpty () || idx >= len || n == 0) + return *this; + + if ((idx + n > len) || n < 0) + n = len - idx; + else + { + int32 toMove = len - idx - n; + if (buffer) + { + if (isWide) + memmove (buffer16 + idx, buffer16 + idx + n, toMove * sizeof (char16)); + else + memmove (buffer8 + idx, buffer8 + idx + n, toMove * sizeof (char8)); + } + } + + resize (len - n, isWide); + updateLength (); + + return *this; +} + +//----------------------------------------------------------------------------- +bool String::removeSubString (const ConstString& subString, bool allOccurences) +{ + bool removed = false; + while (!removed || allOccurences) + { + int32 idx = findFirst (subString); + if (idx < 0) + break; + remove (idx, subString.length ()); + removed = true; + } + return removed; +} + +//----------------------------------------------------------------------------- +template +static uint32 performTrim (T* str, uint32 length, F func, bool funcResult) +{ + uint32 toRemoveAtHead = 0; + uint32 toRemoveAtTail = 0; + + T* p = str; + + while ((*p) && ((func (*p) != 0) == funcResult)) + p++; + + toRemoveAtHead = static_cast(p - str); + + if (toRemoveAtHead < length) + { + p = str + length - 1; + + while (((func (*p) != 0) == funcResult) && (p > str)) + { + p--; + toRemoveAtTail++; + } + } + + uint32 newLength = length - (toRemoveAtHead + toRemoveAtTail); + if (newLength != length) + { + if (toRemoveAtHead) + memmove (str, str + toRemoveAtHead, newLength * sizeof (T)); + } + return newLength; +} + +// "trim" trims the leading and trailing unwanted characters from the string. +//----------------------------------------------------------------------------- +bool String::trim (String::CharGroup group) +{ + if (isEmpty ()) + return false; + + uint32 newLength; + + switch (group) + { + case kSpace: + if (isWide) + newLength = performTrim (buffer16, len, iswspace, true); + else + newLength = performTrim (buffer8, len, isspace, true); + break; + + case kNotAlphaNum: + if (isWide) + newLength = performTrim (buffer16, len, iswalnum, false); + else + newLength = performTrim (buffer8, len, isalnum, false); + break; + + case kNotAlpha: + if (isWide) + newLength = performTrim (buffer16, len, iswalpha, false); + else + newLength = performTrim (buffer8, len, isalpha, false); + break; + + default: // Undefined enum value + return false; + } + + if (newLength != len) + { + resize (newLength, isWide); + len = newLength; + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +template +static uint32 performRemove (T* str, uint32 length, F func, bool funcResult) +{ + T* p = str; + + while (*p) + { + if ((func (*p) != 0) == funcResult) + { + size_t toMove = length - (p - str); + memmove (p, p + 1, toMove * sizeof (T)); + length--; + } + else + p++; + } + return length; +} +//----------------------------------------------------------------------------- +void String::removeChars (CharGroup group) +{ + if (isEmpty ()) + return; + + uint32 newLength; + + switch (group) + { + case kSpace: + if (isWide) + newLength = performRemove (buffer16, len, iswspace, true); + else + newLength = performRemove (buffer8, len, isspace, true); + break; + + case kNotAlphaNum: + if (isWide) + newLength = performRemove (buffer16, len, iswalnum, false); + else + newLength = performRemove (buffer8, len, isalnum, false); + break; + + case kNotAlpha: + if (isWide) + newLength = performRemove (buffer16, len, iswalpha, false); + else + newLength = performRemove (buffer8, len, isalpha, false); + break; + + default: // Undefined enum value + return; + } + + if (newLength != len) + { + resize (newLength, isWide); + len = newLength; + } +} + +//----------------------------------------------------------------------------- +template +static uint32 performRemoveChars (T* str, uint32 length, const T* toRemove) +{ + T* p = str; + + while (*p) + { + bool found = false; + const T* rem = toRemove; + while (*rem) + { + if (*p == *rem) + { + found = true; + break; + } + rem++; + } + + if (found) + { + size_t toMove = length - (p - str); + memmove (p, p + 1, toMove * sizeof (T)); + length--; + } + else + p++; + } + return length; +} + +//----------------------------------------------------------------------------- +bool String::removeChars8 (const char8* toRemove) +{ + if (isEmpty () || toRemove == 0) + return true; + + if (isWide) + { + String wStr (toRemove); + if (wStr.toWideString () == false) + return false; + return removeChars16 (wStr.text16 ()); + } + + uint32 newLength = performRemoveChars (buffer8, len, toRemove); + + if (newLength != len) + { + resize (newLength, false); + len = newLength; + } + return true; +} + +//----------------------------------------------------------------------------- +bool String::removeChars16 (const char16* toRemove) +{ + if (isEmpty () || toRemove == 0) + return true; + + if (!isWide) + { + String str8 (toRemove); + if (str8.toMultiByte () == false) + return false; + return removeChars8 (str8.text8 ()); + } + + uint32 newLength = performRemoveChars (buffer16, len, toRemove); + + if (newLength != len) + { + resize (newLength, true); + len = newLength; + } + return true; +} + +//----------------------------------------------------------------------------- +String& String::printf (const char8* format, ...) +{ + char8 string[kPrintfBufferSize]; + + va_list marker; + va_start (marker, format); + + vsnprintf (string, kPrintfBufferSize, format, marker); + return assign (string); +} + + +//----------------------------------------------------------------------------- +String& String::printf (const char16* format, ...) +{ + char16 string[kPrintfBufferSize]; + + va_list marker; + va_start (marker, format); + + vsnwprintf (string, kPrintfBufferSize, format, marker); + return assign (string); +} + +//----------------------------------------------------------------------------- +String& String::vprintf (const char8* format, va_list args) +{ + char8 string[kPrintfBufferSize]; + + vsnprintf (string, kPrintfBufferSize, format, args); + return assign (string); +} + +//----------------------------------------------------------------------------- +String& String::vprintf (const char16* format, va_list args) +{ + char16 string[kPrintfBufferSize]; + + vsnwprintf (string, kPrintfBufferSize, format, args); + return assign (string); +} + +//----------------------------------------------------------------------------- +String& String::printInt64 (int64 value) +{ + if (isWide) + { + #if SMTG_CPP11 + return String::printf (STR("%") STR(FORMAT_INT64A), value); + #else + return String::printf (STR("%" FORMAT_INT64A), value); + #endif + } + else + return String::printf ("%" FORMAT_INT64A, value); +} + +//----------------------------------------------------------------------------- +String& String::printFloat (double value) +{ + if (isWide) + { + char16 string[kPrintfBufferSize]; + sprintf16 (string, STR16 ("%lf"), value); + + char16* pointPtr = strrchr16 (string, STR ('.')); + if (pointPtr) + { + pointPtr++; // keep 1st digit after point + int32 index = strlen16 (string) - 1; + char16 zero = STR16 ('0'); + while (pointPtr < (string + index)) + { + if (string[index] == zero) + { + string[index] = 0; + index--; + } + else + break; + } + } + return assign (string); + } + else + { + char8 string[kPrintfBufferSize]; + sprintf (string, "%lf", value); + + char8* pointPtr = strrchr (string, '.'); + if (pointPtr) + { + pointPtr++; // keep 1st digit after point + int32 index = (int32) (strlen (string) - 1); + while (pointPtr < (string + index)) + { + if (string[index] == '0') + { + string[index] = 0; + index--; + } + else + break; + } + } + return assign (string); + } +} + +//----------------------------------------------------------------------------- +bool String::incrementTrailingNumber (uint32 width, tchar separator, uint32 minNumber, bool applyOnlyFormat) +{ + if (width > 32) + return false; + + int64 number = 1; + int32 index = getTrailingNumberIndex (); + if (index >= 0) + { + if (scanInt64 (number, index)) + if (!applyOnlyFormat) + number++; + + if (separator != 0 && index > 0 && testChar (index - 1, separator) == true) + index--; + + remove (index); + } + + if (number < minNumber) + number = minNumber; + + if (isWide) + { + char16 format[64]; + char16 trail[128]; + if (separator && isEmpty () == false) + { + sprintf16 (format, STR16 ("%%c%%0%uu"), width); + sprintf16 (trail, format, separator, (uint32) number); + } + else + { + sprintf16 (format, STR16 ("%%0%uu"), width); + sprintf16 (trail, format, (uint32) number); + } + append (trail); + } + else + { + char format[64]; + char trail[128]; + if (separator && isEmpty () == false) + { + sprintf (format, "%%c%%0%uu", width); + sprintf (trail, format, separator, (uint32) number); + } + else + { + sprintf (format, "%%0%uu", width); + sprintf (trail, format, (uint32) number); + } + append (trail); + } + + return true; +} + +//----------------------------------------------------------------------------- +void String::toLower (uint32 index) +{ + if (buffer && index < len) + { + if (isWide) + buffer16[index] = ConstString::toLower (buffer16[index]); + else + buffer8[index] = ConstString::toLower (buffer8[index]); + } +} + +//----------------------------------------------------------------------------- +void String::toLower () +{ + int32 i = len; + if (buffer && i > 0) + { + if (isWide) + { +#if MAC + CFMutableStringRef cfStr = CFStringCreateMutableWithExternalCharactersNoCopy (kCFAllocator, (UniChar*)buffer16, len, len+1, kCFAllocatorNull); + CFStringLowercase (cfStr, NULL); + CFRelease (cfStr); +#else + char16* c = buffer16; + while (i--) + { + *c = ConstString::toLower (*c); + c++; + } +#endif + } + else + { + char8* c = buffer8; + while (i--) + { + *c = ConstString::toLower (*c); + c++; + } + } + } +} + +//----------------------------------------------------------------------------- +void String::toUpper (uint32 index) +{ + if (buffer && index < len) + { + if (isWide) + buffer16[index] = ConstString::toUpper (buffer16[index]); + else + buffer8[index] = ConstString::toUpper (buffer8[index]); + } +} + +//----------------------------------------------------------------------------- +void String::toUpper () +{ + int32 i = len; + if (buffer && i > 0) + { + if (isWide) + { +#if MAC + CFMutableStringRef cfStr = CFStringCreateMutableWithExternalCharactersNoCopy (kCFAllocator, (UniChar*)buffer16, len, len+1, kCFAllocatorNull); + CFStringUppercase (cfStr, NULL); + CFRelease (cfStr); +#else + char16* c = buffer16; + while (i--) + { + *c = ConstString::toUpper (*c); + c++; + } +#endif + } + else + { + char8* c = buffer8; + while (i--) + { + *c = ConstString::toUpper (*c); + c++; + } + } + } +} + +//----------------------------------------------------------------------------- +bool String::fromVariant (const FVariant& var) +{ + switch (var.getType ()) + { + case FVariant::kString8: + assign (var.getString8 ()); + return true; + + case FVariant::kString16: + assign (var.getString16 ()); + return true; + + case FVariant::kFloat: + printFloat (var.getFloat ()); + return true; + + case FVariant::kInteger: + printInt64 (var.getInt ()); + return true; + + default: + remove (); + } + return false; +} + +//----------------------------------------------------------------------------- +void String::toVariant (FVariant& var) const +{ + if (isWide) + { + var.setString16 (text16 ()); + } + else + { + var.setString8 (text8 ()); + } +} + +//----------------------------------------------------------------------------- +bool String::fromAttributes (IAttributes* a, IAttrID attrID) +{ + FVariant variant; + if (a->get (attrID, variant) == kResultTrue) + return fromVariant (variant); + return false; +} + +//----------------------------------------------------------------------------- +bool String::toAttributes (IAttributes* a, IAttrID attrID) +{ + FVariant variant; + toVariant (variant); + if (a->set (attrID, variant) == kResultTrue) + return true; + return false; +} + +// "swapContent" swaps ownership of the strings pointed to +//----------------------------------------------------------------------------- +void String::swapContent (String& s) +{ + void* tmp = s.buffer; + uint32 tmpLen = s.len; + bool tmpWide = s.isWide; + s.buffer = buffer; + s.len = len; + s.isWide = isWide; + buffer = tmp; + len = tmpLen; + isWide = tmpWide; +} + +//----------------------------------------------------------------------------- +void String::take (String& other) +{ + resize (0, other.isWide); + buffer = other.buffer; + len = other.len; + + other.buffer = 0; + other.len = 0; +} + +//----------------------------------------------------------------------------- +void String::take (void* b, bool wide) +{ + resize (0, wide); + buffer = b; + isWide = wide; + updateLength (); +} + +//----------------------------------------------------------------------------- +void* String::pass () +{ + void* res = buffer; + len = 0; + buffer = 0; + return res; +} + +//----------------------------------------------------------------------------- +void String::passToVariant (FVariant& var) +{ + void* passed = pass (); + + if (isWide) + { + if (passed) + { + var.setString16 ((const char16*)passed); + var.setOwner (true); + } + else + var.setString16 (kEmptyString16); + } + else + { + if (passed) + { + var.setString8 ((const char8*)passed); + var.setOwner (true); + } + else + var.setString8 (kEmptyString8); + } +} + + +//----------------------------------------------------------------------------- +unsigned char* String::toPascalString (unsigned char* buf) +{ + if (buffer) + { + if (isWide) + { + String tmp (*this); + tmp.toMultiByte (); + return tmp.toPascalString (buf); + } + + int32 length = len; + if (length > 255) + length = 255; + buf[0] = (uint8)length; + while (length >= 0) + { + buf[length + 1] = buffer8[length]; + length--; + } + return buf; + } + else + { + *buf = 0; + return buf; + } +} + +//----------------------------------------------------------------------------- +const String& String::fromPascalString (const unsigned char* buf) +{ + resize (0, false); + isWide = 0; + int32 length = buf[0]; + resize (length + 1, false); + buffer8[length] = 0; // cannot be removed, because we only do the 0-termination for multibyte buffer8 + while (--length >= 0) + buffer8[length] = buf[length + 1]; + len = buf[0]; + return *this; +} + +#if MAC + +//----------------------------------------------------------------------------- +bool String::fromCFStringRef (const void* cfStr, uint32 encoding) +{ + if (cfStr == 0) + return false; + + CFStringRef strRef = (CFStringRef)cfStr; + if (isWide) + { + CFRange range = { 0, CFStringGetLength (strRef)}; + CFIndex usedBytes; + if (resize (static_cast(range.length + 1), true)) + { + if (encoding == 0xFFFF) + encoding = kCFStringEncodingUnicode; + if (CFStringGetBytes (strRef, range, encoding, ' ', false, (UInt8*)buffer16, range.length * 2, &usedBytes) > 0) + { + buffer16[usedBytes/2] = 0; + this->len = strlen16 (buffer16); + return true; + } + } + } + else + { + if (cfStr == 0) + return false; + if (encoding == 0xFFFF) + encoding = kCFStringEncodingASCII; + int32 len = static_cast(CFStringGetLength (strRef) * 2); + if (resize (++len, false)) + { + if (CFStringGetCString (strRef, buffer8, len, encoding)) + { + this->len = static_cast(strlen (buffer8)); + return true; + } + } + } + + return false; +} + +//----------------------------------------------------------------------------- +void* ConstString::toCFStringRef (uint32 encoding, bool mutableCFString) const +{ + if (mutableCFString) + { + CFMutableStringRef str = CFStringCreateMutable (kCFAllocator, 0); + if (isWide) + { + CFStringAppendCharacters (str, (const UniChar *)buffer16, len); + return str; + } + else + { + if (encoding == 0xFFFF) + encoding = kCFStringEncodingASCII; + CFStringAppendCString (str, buffer8, encoding); + return str; + } + } + else + { + if (isWide) + { + if (encoding == 0xFFFF) + encoding = kCFStringEncodingUnicode; + return (void*)CFStringCreateWithBytes (kCFAllocator, (const unsigned char*)buffer16, len * 2, encoding, false); + } + else + { + if (encoding == 0xFFFF) + encoding = kCFStringEncodingASCII; + if (buffer8) + return (void*)CFStringCreateWithCString (kCFAllocator, buffer8, encoding); + else + return (void*)CFStringCreateWithCString (kCFAllocator, "", encoding); + } + } + return 0; +} + +#endif + +//----------------------------------------------------------------------------- +uint32 hashString8 (const char8* s, uint32 m) +{ + uint32 h = 0; + if (s) + { + for (h = 0; *s != '\0'; s++) + h = (64 * h + *s) % m; + } + return h; +} + +//----------------------------------------------------------------------------- +uint32 hashString16 (const char16* s, uint32 m) +{ + uint32 h = 0; + if (s) + { + for (h = 0; *s != 0; s++) + h = (64 * h + *s) % m; + } + return h; +} + +//------------------------------------------------------------------------ +template int32 tstrnatcmp (const T* s1, const T* s2, bool caseSensitive = true) +{ + if (s1 == 0 && s2 == 0) + return 0; + else if (s1 == 0) + return -1; + else if (s2 == 0) + return 1; + + while (*s1 && *s2) + { + if (ConstString::isCharDigit (*s1) && ConstString::isCharDigit (*s2)) + { + int32 s1LeadingZeros = 0; + while (*s1 == '0') + { + s1++; // skip leading zeros + s1LeadingZeros++; + } + int32 s2LeadingZeros = 0; + while (*s2 == '0') + { + s2++; // skip leading zeros + s2LeadingZeros++; + } + + int32 countS1Digits = 0; + while (*(s1 + countS1Digits) && ConstString::isCharDigit (*(s1 + countS1Digits))) + countS1Digits++; + int32 countS2Digits = 0; + while (*(s2 + countS2Digits) && ConstString::isCharDigit (*(s2 + countS2Digits))) + countS2Digits++; + + if (countS1Digits != countS2Digits) + return countS1Digits - countS2Digits; // one number is longer than the other + + for (int32 i = 0; i < countS1Digits; i++) + { + // countS1Digits == countS2Digits + if (*s1 != *s2) + return (int32)(*s1 - *s2); // the digits differ + s1++; + s2++; + } + + if (s1LeadingZeros != s2LeadingZeros) + return s1LeadingZeros - s2LeadingZeros; // differentiate by the number of leading zeros + } + else + { + if (caseSensitive == false) + { + T srcToUpper = toupper (*s1); + T dstToUpper = toupper (*s2); + if (srcToUpper != dstToUpper) + return (int32)(srcToUpper - dstToUpper); + } + else if (*s1 != *s2) + return (int32)(*s1 - *s2); + + s1++; + s2++; + } + } + + if (*s1 == 0 && *s2 == 0) + return 0; + else if (*s1 == 0) + return -1; + else if (*s2 == 0) + return 1; + else + return (int32)(*s1 - *s2); +} + +//------------------------------------------------------------------------ +int32 strnatcmp8 (const char8* s1, const char8* s2, bool caseSensitive /*= true*/) +{ + return tstrnatcmp (s1, s2, caseSensitive); +} + +//------------------------------------------------------------------------ +int32 strnatcmp16 (const char16* s1, const char16* s2, bool caseSensitive /*= true*/) +{ + return tstrnatcmp (s1, s2, caseSensitive); +} + +//----------------------------------------------------------------------------- +// StringObject Implementation +//----------------------------------------------------------------------------- +void PLUGIN_API StringObject::setText (const char8* text) +{ + assign (text); +} + +//----------------------------------------------------------------------------- +void PLUGIN_API StringObject::setText8 (const char8* text) +{ + assign (text); +} + +//----------------------------------------------------------------------------- +void PLUGIN_API StringObject::setText16 (const char16* text) +{ + assign (text); +} + +//----------------------------------------------------------------------------- +const char8* PLUGIN_API StringObject::getText8 () +{ + return text8 (); +} + +//----------------------------------------------------------------------------- +const char16* PLUGIN_API StringObject::getText16 () +{ + return text16 (); +} + +//----------------------------------------------------------------------------- +void PLUGIN_API StringObject::take (void* s, bool _isWide) +{ + String::take (s, _isWide); +} + +//----------------------------------------------------------------------------- +bool PLUGIN_API StringObject::isWideString () const +{ + return String::isWideString (); +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/fstring.h b/VST3_SDK/base/source/fstring.h new file mode 100644 index 0000000000..717b37c635 --- /dev/null +++ b/VST3_SDK/base/source/fstring.h @@ -0,0 +1,747 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/fstring.h +// Created by : Steinberg, 2008 +// Description : String class +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/ftypes.h" +#include "pluginterfaces/base/fstrdefs.h" +#include "pluginterfaces/base/istringresult.h" +#include "pluginterfaces/base/ipersistent.h" + +#include "base/source/fobject.h" + +#include + +namespace Steinberg { + +class FVariant; +class String; + +#ifdef UNICODE +static const bool kWideStringDefault = true; +#else +static const bool kWideStringDefault = false; +#endif + +static const uint16 kBomUtf16 = 0xFEFF; ///< UTF16 Byte Order Mark +static const char8* const kBomUtf8 = "\xEF\xBB\xBF"; ///< UTF8 Byte Order Mark +static const int32 kBomUtf8Length = 3; + + +enum MBCodePage +{ + kCP_ANSI = 0, ///< Default ANSI codepage. + kCP_MAC_ROMAN = 2, ///< Default Mac codepage. + + kCP_ANSI_WEL = 1252, ///< West European Latin Encoding. + kCP_MAC_CEE = 10029, ///< Mac Central European Encoding. + kCP_Utf8 = 65001, ///< UTF8 Encoding. + kCP_ShiftJIS = 932, ///< Shifted Japan Industrial Standard Encoding. + kCP_US_ASCII = 20127, ///< US-ASCII (7-bit). + + kCP_Default = kCP_ANSI ///< Default ANSI codepage. +}; + +enum UnicodeNormalization +{ + kUnicodeNormC, ///< Unicode normalization Form C, canonical composition. + kUnicodeNormD, ///< Unicode normalization Form D, canonical decomposition. + kUnicodeNormKC, ///< Unicode normalization form KC, compatibility composition. + kUnicodeNormKD ///< Unicode normalization form KD, compatibility decomposition. +}; + +//------------------------------------------------------------------------ +// Helper functions to create hash codes from string data. +//------------------------------------------------------------------------ +extern uint32 hashString8 (const char8* s, uint32 m); +extern uint32 hashString16 (const char16* s, uint32 m); +inline uint32 hashString (const tchar* s, uint32 m) +{ +#ifdef UNICODE + return hashString16 (s, m); +#else + return hashString8 (s, m); +#endif +} + + +//----------------------------------------------------------------------------- +/** Invariant String. +@ingroup adt + +A base class which provides methods to work with its +member string. Neither of the operations allows modifying the member string and +that is why all operation are declared as const. + +There are operations for access, comparison, find, numbers and conversion. + +Almost all operations exist in three versions for char8, char16 and the +polymorphic type tchar. The type tchar can either be char8 or char16 depending +on whether UNICODE is activated or not.*/ +//----------------------------------------------------------------------------- +class ConstString +{ +public: +//----------------------------------------------------------------------------- + ConstString (const char8* str, int32 length = -1); ///< Assign from string of type char8 (length=-1: all) + ConstString (const char16* str, int32 length = -1); ///< Assign from string of type char16 (length=-1: all) + ConstString (const ConstString& str, int32 offset = 0, int32 length = -1); ///< Copy constructor (length=-1: all). + ConstString (const FVariant& var); ///< Assign a string from FVariant + ConstString (); + virtual ~ConstString () {} ///< Destructor. + + // access ----------------------------------------------------------------- + virtual int32 length () const {return len;} ///< Return length of string + inline bool isEmpty () const {return buffer == 0 || len == 0;} ///< Return true if sting is empty + + operator const char8* () const {return text8 ();} ///< Returns pointer to string of type char8 (no modification allowed) + operator const char16* () const {return text16 ();} ///< Returns pointer to string of type char16(no modification allowed) + inline tchar operator[] (short idx) const {return getChar (idx);} ///< Returns character at 'idx' + inline tchar operator[] (long idx) const {return getChar (static_cast(idx));} + inline tchar operator[] (int idx) const {return getChar (idx);} + inline tchar operator[] (unsigned short idx) const {return getChar (idx);} + inline tchar operator[] (unsigned long idx) const {return getChar (static_cast(idx));} + inline tchar operator[] (unsigned int idx) const {return getChar (idx);} + + inline virtual const char8* text8 () const; ///< Returns pointer to string of type char8 + inline virtual const char16* text16 () const; ///< Returns pointer to string of type char16 + inline virtual const tchar* text () const; ///< Returns pointer to string of type tchar + inline virtual const void* ptr () const {return buffer;} ///< Returns pointer to string of type void + + inline virtual char8 getChar8 (uint32 index) const; ///< Returns character of type char16 at 'index' + inline virtual char16 getChar16 (uint32 index) const; ///< Returns character of type char8 at 'index' + inline tchar getChar (uint32 index) const; ///< Returns character of type tchar at 'index' + inline tchar getCharAt (uint32 index) const; ///< Returns character of type tchar at 'index', no conversion! + + bool testChar8 (uint32 index, char8 c) const; ///< Returns true if character is equal at position 'index' + bool testChar16 (uint32 index, char16 c) const; + inline bool testChar (uint32 index, char8 c) const {return testChar8 (index, c);} + inline bool testChar (uint32 index, char16 c) const {return testChar16 (index, c);} + + bool extract (String& result, uint32 idx, int32 n = -1) const; ///< Get n characters long substring starting at index (n=-1: until end) + int32 copyTo8 (char8* str, uint32 idx = 0, int32 n = -1) const; + int32 copyTo16 (char16* str, uint32 idx = 0, int32 n = -1) const; + int32 copyTo (tchar* str, uint32 idx = 0, int32 n = -1) const; + void copyTo (IStringResult* result) const; ///< Copies whole member string + void copyTo (IString& string) const; ///< Copies whole member string + + inline uint32 hash (uint32 tsize) const + { + return isWide ? hashString16 (buffer16, tsize) : hashString8 (buffer8, tsize) ; + } + //------------------------------------------------------------------------- + + // compare ---------------------------------------------------------------- + enum CompareMode + { + kCaseSensitive, ///< Comparison is done with regard to character's case + kCaseInsensitive ///< Comparison is done without regard to character's case + }; + + int32 compareAt (uint32 index, const ConstString& str, int32 n = -1, CompareMode m = kCaseSensitive) const; ///< Compare n characters of str with n characters of this starting at index (return: see above) + int32 compare (const ConstString& str, int32 n, CompareMode m = kCaseSensitive) const; ///< Compare n characters of str with n characters of this (return: see above) + int32 compare (const ConstString& str, CompareMode m = kCaseSensitive) const; ///< Compare all characters of str with this (return: see above) + + int32 naturalCompare (const ConstString& str, CompareMode mode = kCaseSensitive) const; + + bool startsWith (const ConstString& str, CompareMode m = kCaseSensitive) const; ///< Check if this starts with str + bool endsWith (const ConstString& str, CompareMode m = kCaseSensitive) const; ///< Check if this ends with str + bool contains (const ConstString& str, CompareMode m = kCaseSensitive) const; ///< Check if this contains str + + // static methods + static bool isCharSpace (char8 character); ///< Returns true if character is a space + static bool isCharSpace (char16 character); ///< @copydoc isCharSpace(const char8) + static bool isCharAlpha (char8 character); ///< Returns true if character is an alphabetic character + static bool isCharAlpha (char16 character); ///< @copydoc isCharAlpha(const char8) + static bool isCharAlphaNum (char8 character); ///< Returns true if character is an alphanumeric character + static bool isCharAlphaNum (char16 character); ///< @copydoc isCharAlphaNum(const char8) + static bool isCharDigit (char8 character); ///< Returns true if character is a number + static bool isCharDigit (char16 character); ///< @copydoc isCharDigit(const char8) + static bool isCharAscii (char8 character); ///< Returns true if character is in ASCII range + static bool isCharAscii (char16 character); ///< Returns true if character is in ASCII range + static bool isCharUpper (char8 character); + static bool isCharUpper (char16 character); + static bool isCharLower (char8 character); + static bool isCharLower (char16 character); + //------------------------------------------------------------------------- + + /** @name Find first occurrence of n characters of str in this (n=-1: all) ending at endIndex (endIndex = -1: all)*/ + ///@{ + inline int32 findFirst (const ConstString& str, int32 n = -1, CompareMode m = kCaseSensitive, int32 endIndex = -1) const {return findNext (0, str, n, m, endIndex);} + inline int32 findFirst (char8 c, CompareMode m = kCaseSensitive, int32 endIndex = -1) const {return findNext (0, c, m, endIndex);} + inline int32 findFirst (char16 c, CompareMode m = kCaseSensitive, int32 endIndex = -1) const {return findNext (0, c, m, endIndex);} + ///@} + /** @name Find next occurrence of n characters of str starting at startIndex in this (n=-1: all) ending at endIndex (endIndex = -1: all)*/ + ///@{ + int32 findNext (int32 startIndex, const ConstString& str, int32 n = -1, CompareMode = kCaseSensitive, int32 endIndex = -1) const; + int32 findNext (int32 startIndex, char8 c, CompareMode = kCaseSensitive, int32 endIndex = -1) const; + int32 findNext (int32 startIndex, char16 c, CompareMode = kCaseSensitive, int32 endIndex = -1) const; + ///@} + /** @name Find previous occurrence of n characters of str starting at startIndex in this (n=-1: all) */ + ///@{ + int32 findPrev (int32 startIndex, const ConstString& str, int32 n = -1, CompareMode = kCaseSensitive) const; + int32 findPrev (int32 startIndex, char8 c, CompareMode = kCaseSensitive) const; + int32 findPrev (int32 startIndex, char16 c, CompareMode = kCaseSensitive) const; + ///@} + + inline int32 findLast (const ConstString& str, int32 n = -1, CompareMode m = kCaseSensitive) const {return findPrev (-1, str, n, m);} ///< Find last occurrence of n characters of str in this (n=-1: all) + inline int32 findLast (char8 c, CompareMode m = kCaseSensitive) const {return findPrev (-1, c, m);} + inline int32 findLast (char16 c, CompareMode m = kCaseSensitive) const {return findPrev (-1, c, m);} + + int32 countOccurences (char8 c, uint32 startIndex, CompareMode = kCaseSensitive) const; ///< Counts occurences of c within this starting at index + int32 countOccurences (char16 c, uint32 startIndex, CompareMode = kCaseSensitive) const; + int32 getFirstDifferent (const ConstString& str, CompareMode = kCaseSensitive) const; ///< Returns position of first different character + //------------------------------------------------------------------------- + + // numbers ---------------------------------------------------------------- + bool isDigit (uint32 index) const; ///< Returns true if character at position is a digit + bool scanFloat (double& value, uint32 offset = 0, bool scanToEnd = true) const; ///< Converts string to double value starting at offset + bool scanInt64 (int64& value, uint32 offset = 0, bool scanToEnd = true) const; ///< Converts string to int64 value starting at offset + bool scanUInt64 (uint64& value, uint32 offset = 0, bool scanToEnd = true) const; ///< Converts string to uint64 value starting at offset + bool scanInt32 (int32& value, uint32 offset = 0, bool scanToEnd = true) const; ///< Converts string to int32 value starting at offset + bool scanUInt32 (uint32& value, uint32 offset = 0, bool scanToEnd = true) const; ///< Converts string to uint32 value starting at offset + bool scanHex (uint8& value, uint32 offset = 0, bool scanToEnd = true) const; ///< Converts string to hex/uint8 value starting at offset + + int32 getTrailingNumberIndex (uint32 width = 0) const; ///< Returns start index of trailing number + int64 getTrailingNumber (int64 fallback = 0) const; ///< Returns result of scanInt64 or the fallback + int64 getNumber () const; ///< Returns result of scanInt64 + + // static methods + static bool scanInt64_8 (const char8* text, int64& value, bool scanToEnd = true); ///< Converts string of type char8 to int64 value + static bool scanInt64_16 (const char16* text, int64& value, bool scanToEnd = true); ///< Converts string of type char16 to int64 value + static bool scanInt64 (const tchar* text, int64& value, bool scanToEnd = true); ///< Converts string of type tchar to int64 value + + static bool scanUInt64_8 (const char8* text, uint64& value, bool scanToEnd = true); ///< Converts string of type char8 to uint64 value + static bool scanUInt64_16 (const char16* text, uint64& value, bool scanToEnd = true); ///< Converts string of type char16 to uint64 value + static bool scanUInt64 (const tchar* text, uint64& value, bool scanToEnd = true); ///< Converts string of type tchar to uint64 value + + static bool scanInt32_8 (const char8* text, int32& value, bool scanToEnd = true); ///< Converts string of type char8 to int32 value + static bool scanInt32_16 (const char16* text, int32& value, bool scanToEnd = true); ///< Converts string of type char16 to int32 value + static bool scanInt32 (const tchar* text, int32& value, bool scanToEnd = true); ///< Converts string of type tchar to int32 value + + static bool scanUInt32_8 (const char8* text, uint32& value, bool scanToEnd = true); ///< Converts string of type char8 to int32 value + static bool scanUInt32_16 (const char16* text, uint32& value, bool scanToEnd = true); ///< Converts string of type char16 to int32 value + static bool scanUInt32 (const tchar* text, uint32& value, bool scanToEnd = true); ///< Converts string of type tchar to int32 value + + static bool scanHex_8 (const char8* text, uint8& value, bool scanToEnd = true); ///< Converts string of type char8 to hex/unit8 value + static bool scanHex_16 (const char16* text, uint8& value, bool scanToEnd = true); ///< Converts string of type char16 to hex/unit8 value + static bool scanHex (const tchar* text, uint8& value, bool scanToEnd = true); ///< Converts string of type tchar to hex/unit8 value + //------------------------------------------------------------------------- + + // conversion ------------------------------------------------------------- + void toVariant (FVariant& var) const; + + static char8 toLower (char8 c); ///< Converts to lower case + static char8 toUpper (char8 c); ///< Converts to upper case + static char16 toLower (char16 c); + static char16 toUpper (char16 c); + + static int32 multiByteToWideString (char16* dest, const char8* source, int32 wcharCount, uint32 sourceCodePage = kCP_Default); ///< If dest is zero, this returns the maximum number of bytes needed to convert source + static int32 wideStringToMultiByte (char8* dest, const char16* source, int32 char8Count, uint32 destCodePage = kCP_Default); ///< If dest is zero, this returns the maximum number of bytes needed to convert source + + bool isWideString () const {return isWide != 0;} ///< Returns true if string is wide + bool isAsciiString () const; ///< Checks if all characters in string are in ascii range + + bool isNormalized (UnicodeNormalization = kUnicodeNormC); ///< On PC only kUnicodeNormC is working + +#if MAC + virtual void* toCFStringRef (uint32 encoding = 0xFFFF, bool mutableCFString = false) const; ///< CFString conversion +#endif +//------------------------------------------------------------------------- + +//----------------------------------------------------------------------------- +protected: + + union + { + void* buffer; + char8* buffer8; + char16* buffer16; + }; + uint32 len : 30; + uint32 isWide : 1; +}; + +//----------------------------------------------------------------------------- +/** String. +@ingroup adt + +Extends class ConstString by operations which allow modifications. + +\see ConstString */ +//----------------------------------------------------------------------------- +class String : public ConstString +{ +public: +//----------------------------------------------------------------------------- + String (); + String (const char8* str, MBCodePage codepage, int32 n = -1, bool isTerminated = true); ///< assign n characters of str and convert to wide string by using the specified codepage + String (const char8* str, int32 n = -1, bool isTerminated = true); ///< assign n characters of str (-1: all) + String (const char16* str, int32 n = -1, bool isTerminated = true); ///< assign n characters of str (-1: all) + String (const String& str, int32 n = -1); ///< assign n characters of str (-1: all) + String (const ConstString& str, int32 n = -1); ///< assign n characters of str (-1: all) + String (const FVariant& var); ///< assign from FVariant + String (IString* str); ///< assign from IString + ~String (); + +#if SMTG_CPP11_STDLIBSUPPORT + String (String&& str); + String& operator= (String&& str); +#endif + + // access------------------------------------------------------------------ + void updateLength (); ///< Call this when the string is truncated outside (not recommended though) + virtual const char8* text8 () const SMTG_OVERRIDE; + virtual const char16* text16 () const SMTG_OVERRIDE; + virtual char8 getChar8 (uint32 index) const SMTG_OVERRIDE; + virtual char16 getChar16 (uint32 index) const SMTG_OVERRIDE; + + bool setChar8 (uint32 index, char8 c); + bool setChar16 (uint32 index, char16 c); + inline bool setChar (uint32 index, char8 c) {return setChar8 (index, c);} + inline bool setChar (uint32 index, char16 c) {return setChar16 (index, c);} + //------------------------------------------------------------------------- + + // assignment-------------------------------------------------------------- + String& operator= (const char8* str) {return assign (str);} ///< Assign from a string of type char8 + String& operator= (const char16* str) {return assign (str);} + String& operator= (const ConstString& str) {return assign (str);} + String& operator= (const String& str) {return assign (str);} + String& operator= (char8 c) {return assign (c);} + String& operator= (char16 c) {return assign (c);} + + String& assign (const ConstString& str, int32 n = -1); ///< Assign n characters of str (-1: all) + String& assign (const char8* str, int32 n = -1, bool isTerminated = true); ///< Assign n characters of str (-1: all) + String& assign (const char16* str, int32 n = -1, bool isTerminated = true); ///< Assign n characters of str (-1: all) + String& assign (char8 c, int32 n = 1); + String& assign (char16 c, int32 n = 1); + //------------------------------------------------------------------------- + + // concat------------------------------------------------------------------ + String& append (const ConstString& str, int32 n = -1); ///< Append n characters of str to this (n=-1: all) + String& append (const char8* str, int32 n = -1); ///< Append n characters of str to this (n=-1: all) + String& append (const char16* str, int32 n = -1); ///< Append n characters of str to this (n=-1: all) + String& append (const char8 c, int32 n = 1); ///< Append char c n times + String& append (const char16 c, int32 n = 1); ///< Append char c n times + + String& insertAt (uint32 idx, const ConstString& str, int32 n = -1); ///< Insert n characters of str at position idx (n=-1: all) + String& insertAt (uint32 idx, const char8* str, int32 n = -1); ///< Insert n characters of str at position idx (n=-1: all) + String& insertAt (uint32 idx, const char16* str, int32 n = -1); ///< Insert n characters of str at position idx (n=-1: all) + String& insertAt (uint32 idx, char8 c) {char8 str[] = {c, 0}; return insertAt (idx, str, 1);} + String& insertAt (uint32 idx, char16 c) {char16 str[] = {c, 0}; return insertAt (idx, str, 1);} + + String& operator+= (const String& str) {return append (str);} + String& operator+= (const ConstString& str) {return append (str);} + String& operator+= (const char8* str) {return append (str);} + String& operator+= (const char16* str) {return append (str);} + String& operator+= (const char8 c) {return append (c);} + String& operator+= (const char16 c) {return append (c);} + //------------------------------------------------------------------------- + + // replace----------------------------------------------------------------- + String& replace (uint32 idx, int32 n1, const ConstString& str, int32 n2 = -1); ///< Replace n1 characters of this (starting at idx) with n2 characters of str (n1,n2=-1: until end) + String& replace (uint32 idx, int32 n1, const char8* str, int32 n2 = -1); ///< Replace n1 characters of this (starting at idx) with n2 characters of str (n1,n2=-1: until end) + String& replace (uint32 idx, int32 n1, const char16* str, int32 n2 = -1); ///< Replace n1 characters of this (starting at idx) with n2 characters of str (n1,n2=-1: until end) + + int32 replace (const char8* toReplace, const char8* toReplaceWith, bool all = false, CompareMode m = kCaseSensitive); ///< Replace find string with replace string - returns number of replacements + int32 replace (const char16* toReplace, const char16* toReplaceWith, bool all = false, CompareMode m = kCaseSensitive); ///< Replace find string with replace string - returns number of replacements + + bool replaceChars8 (const char8* toReplace, char8 toReplaceBy); ///< Returns true when any replacement was done + bool replaceChars16 (const char16* toReplace, char16 toReplaceBy); + inline bool replaceChars8 (char8 toReplace, char8 toReplaceBy) {char8 str[] = {toReplace, 0}; return replaceChars8 (str, toReplaceBy);} + inline bool replaceChars16 (char16 toReplace, char16 toReplaceBy) {char16 str[] = {toReplace, 0}; return replaceChars16 (str, toReplaceBy);} + inline bool replaceChars (char8 toReplace, char8 toReplaceBy) {return replaceChars8 (toReplace, toReplaceBy);} + inline bool replaceChars (char16 toReplace, char16 toReplaceBy) {return replaceChars16 (toReplace, toReplaceBy);} + inline bool replaceChars (const char8* toReplace, char8 toReplaceBy) {return replaceChars8 (toReplace, toReplaceBy);} + inline bool replaceChars (const char16* toReplace, char16 toReplaceBy) {return replaceChars16 (toReplace, toReplaceBy);} + //------------------------------------------------------------------------- + + // remove------------------------------------------------------------------ + String& remove (uint32 index = 0, int32 n = -1); ///< Remove n characters from string starting at index (n=-1: until end) + enum CharGroup {kSpace, kNotAlphaNum, kNotAlpha}; + bool trim (CharGroup mode = kSpace); ///< Trim lead/trail. + void removeChars (CharGroup mode = kSpace); ///< Removes all of group. + bool removeChars8 (const char8* which); ///< Remove all occurrences of each char in 'which' + bool removeChars16 (const char16* which); ///< Remove all occurrences of each char in 'which' + inline bool removeChars8 (const char8 which) {char8 str[] = {which, 0}; return removeChars8 (str); } + inline bool removeChars16 (const char16 which) {char16 str[] = {which, 0}; return removeChars16 (str); } + inline bool removeChars (const char8* which) {return removeChars8 (which);} + inline bool removeChars (const char16* which) {return removeChars16 (which);} + inline bool removeChars (const char8 which) {return removeChars8 (which);} + inline bool removeChars (const char16 which) {return removeChars16 (which);} + bool removeSubString (const ConstString& subString, bool allOccurences = true); + //------------------------------------------------------------------------- + + // print------------------------------------------------------------------- + String& printf (const char8* format, ...); ///< Print formatted data into string + String& printf (const char16* format, ...); ///< Print formatted data into string + String& vprintf (const char8* format, va_list args); + String& vprintf (const char16* format, va_list args); + //------------------------------------------------------------------------- + + // numbers----------------------------------------------------------------- + String& printInt64 (int64 value); + String& printFloat (double value); + /** Increment the trailing number if present else start with minNumber, width specifies the string width format (width 2 for number 3 is 03), + applyOnlyFormat set to true will only format the string to the given width without incrementing the founded trailing number */ + bool incrementTrailingNumber (uint32 width = 2, tchar separator = STR (' '), uint32 minNumber = 1, bool applyOnlyFormat = false); + //------------------------------------------------------------------------- + + // conversion-------------------------------------------------------------- + bool fromVariant (const FVariant& var); ///< Assigns string from FVariant + void toVariant (FVariant& var) const; + bool fromAttributes (IAttributes* a, IAttrID attrID); ///< Assigns string from FAttributes + bool toAttributes (IAttributes* a, IAttrID attrID); + + void swapContent (String& s); ///< Swaps ownership of the strings pointed to + void take (String& str); ///< Take ownership of the string of 'str' + void take (void* _buffer, bool wide); ///< Take ownership of buffer + void* pass (); + void passToVariant (FVariant& var); ///< Pass ownership of buffer to Variant - sets Variant ownership + + void toLower (uint32 index); ///< Lower case the character. + void toLower (); ///< Lower case the string. + void toUpper (uint32 index); ///< Upper case the character. + void toUpper (); ///< Upper case the string. + + unsigned char* toPascalString (unsigned char* buf); ///< Pascal string conversion + const String& fromPascalString (const unsigned char* buf); ///< Pascal string conversion + + bool toWideString (uint32 sourceCodePage = kCP_Default); ///< Converts to wide string according to sourceCodePage + bool toMultiByte (uint32 destCodePage = kCP_Default); + + void fromUTF8 (const char8* utf8String); ///< Assigns from UTF8 string + bool normalize (UnicodeNormalization = kUnicodeNormC); ///< On PC only kUnicodeNormC is working + +#if MAC + virtual bool fromCFStringRef (const void*, uint32 encoding = 0xFFFF); ///< CFString conversion +#endif + //------------------------------------------------------------------------- + + //----------------------------------------------------------------------------- +protected: + bool resize (uint32 newSize, bool wide, bool fill = false); + +private: + void tryFreeBuffer (); + bool checkToMultiByte (uint32 destCodePage = kCP_Default) const; // to remove debug code from inline - const_cast inside!!! +}; + +// String concatenation functions. +inline String operator+ (const ConstString& s1, const ConstString& s2) {return String (s1).append (s2);} +inline String operator+ (const ConstString& s1, const char8* s2) {return String (s1).append (s2);} +inline String operator+ (const ConstString& s1, const char16* s2) {return String (s1).append (s2);} +inline String operator+ (const char8* s1, const ConstString& s2) {return String (s1).append (s2);} +inline String operator+ (const char16* s1, const ConstString& s2) {return String (s1).append (s2);} +inline String operator+ (const ConstString& s1, const String& s2) {return String (s1).append (s2);} +inline String operator+ (const String& s1, const ConstString& s2) {return String (s1).append (s2);} +inline String operator+ (const String& s1, const String& s2) {return String (s1).append (s2);} +inline String operator+ (const String& s1, const char8* s2) {return String (s1).append (s2);} +inline String operator+ (const String& s1, const char16* s2) {return String (s1).append (s2);} +inline String operator+ (const char8* s1, const String& s2) {return String (s1).append (s2);} +inline String operator+ (const char16* s1, const String& s2) {return String (s1).append (s2);} + +//----------------------------------------------------------------------------- +// ConstString +//----------------------------------------------------------------------------- +inline const tchar* ConstString::text () const +{ +#ifdef UNICODE + return text16 (); +#else + return text8 (); +#endif +} + +//----------------------------------------------------------------------------- +inline const char8* ConstString::text8 () const +{ + return (!isWide && buffer8) ? buffer8: kEmptyString8; +} + +//----------------------------------------------------------------------------- +inline const char16* ConstString::text16 () const +{ + return (isWide && buffer16) ? buffer16 : kEmptyString16; +} + +//----------------------------------------------------------------------------- +inline char8 ConstString::getChar8 (uint32 index) const +{ + if (index < len && buffer8 && !isWide) + return buffer8[index]; + return 0; +} + +//----------------------------------------------------------------------------- +inline char16 ConstString::getChar16 (uint32 index) const +{ + if (index < len && buffer16 && isWide) + return buffer16[index]; + return 0; +} + +//----------------------------------------------------------------------------- +inline tchar ConstString::getChar (uint32 index) const +{ +#ifdef UNICODE + return getChar16 (index); +#else + return getChar8 (index); +#endif +} + +//----------------------------------------------------------------------------- +inline tchar ConstString::getCharAt (uint32 index) const +{ +#ifdef UNICODE + if (isWide) + return getChar16 (index); +#endif + + return getChar8 (index); +} + +//----------------------------------------------------------------------------- +inline int64 ConstString::getNumber () const +{ + int64 tmp = 0; + scanInt64 (tmp); + return tmp; +} + +//----------------------------------------------------------------------------- +inline bool ConstString::scanInt32_8 (const char8* text, int32& value, bool scanToEnd) +{ + int64 tmp; + if (scanInt64_8 (text, tmp, scanToEnd)) + { + value = (int32)tmp; + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +inline bool ConstString::scanInt32_16 (const char16* text, int32& value, bool scanToEnd) +{ + int64 tmp; + if (scanInt64_16 (text, tmp, scanToEnd)) + { + value = (int32)tmp; + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +inline bool ConstString::scanInt32 (const tchar* text, int32& value, bool scanToEnd) +{ + int64 tmp; + if (scanInt64 (text, tmp, scanToEnd)) + { + value = (int32)tmp; + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +inline bool ConstString::scanUInt32_8 (const char8* text, uint32& value, bool scanToEnd) +{ + uint64 tmp; + if (scanUInt64_8 (text, tmp, scanToEnd)) + { + value = (uint32)tmp; + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +inline bool ConstString::scanUInt32_16 (const char16* text, uint32& value, bool scanToEnd) +{ + uint64 tmp; + if (scanUInt64_16 (text, tmp, scanToEnd)) + { + value = (uint32)tmp; + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +inline bool ConstString::scanUInt32 (const tchar* text, uint32& value, bool scanToEnd) +{ + uint64 tmp; + if (scanUInt64 (text, tmp, scanToEnd)) + { + value = (uint32)tmp; + return true; + } + return false; +} + +//----------------------------------------------------------------------------- +inline const char8* String::text8 () const +{ + if (isWide && !isEmpty ()) + checkToMultiByte (); // this should be avoided, since it can lead to information loss + + return ConstString::text8 (); +} + +//----------------------------------------------------------------------------- +inline const char16* String::text16 () const +{ + if (!isWide && !isEmpty ()) + { + const_cast (*this).toWideString (); + } + return ConstString::text16 (); +} + +//----------------------------------------------------------------------------- +inline char8 String::getChar8 (uint32 index) const +{ + if (isWide && !isEmpty ()) + checkToMultiByte (); // this should be avoided, since it can lead to information loss + + return ConstString::getChar8 (index); +} + +//----------------------------------------------------------------------------- +inline char16 String::getChar16 (uint32 index) const +{ + if (!isWide && !isEmpty ()) + { + const_cast (*this).toWideString (); + } + return ConstString::getChar16 (index); +} + +//----------------------------------------------------------------------------- + + +inline bool operator< (const ConstString& s1, const ConstString& s2) {return (s1.compare (s2) < 0) ? true : false;} +inline bool operator<= (const ConstString& s1, const ConstString& s2) {return (s1.compare (s2) <= 0) ? true : false;} +inline bool operator> (const ConstString& s1, const ConstString& s2) {return (s1.compare (s2) > 0) ? true : false;} +inline bool operator>= (const ConstString& s1, const ConstString& s2) {return (s1.compare (s2) >= 0) ? true : false;} +inline bool operator== (const ConstString& s1, const ConstString& s2) {return (s1.compare (s2) == 0) ? true : false;} +inline bool operator!= (const ConstString& s1, const ConstString& s2) {return (s1.compare (s2) != 0) ? true : false;} + +inline bool operator< (const ConstString& s1, const char8* s2) {return (s1.compare (s2) < 0) ? true : false;} +inline bool operator<= (const ConstString& s1, const char8* s2) {return (s1.compare (s2) <= 0) ? true : false;} +inline bool operator> (const ConstString& s1, const char8* s2) {return (s1.compare (s2) > 0) ? true : false;} +inline bool operator>= (const ConstString& s1, const char8* s2) {return (s1.compare (s2) >= 0) ? true : false;} +inline bool operator== (const ConstString& s1, const char8* s2) {return (s1.compare (s2) == 0) ? true : false;} +inline bool operator!= (const ConstString& s1, const char8* s2) {return (s1.compare (s2) != 0) ? true : false;} +inline bool operator< (const char8* s1, const ConstString& s2) {return (s2.compare (s1) > 0) ? true : false;} +inline bool operator<= (const char8* s1, const ConstString& s2) {return (s2.compare (s1) >= 0) ? true : false;} +inline bool operator> (const char8* s1, const ConstString& s2) {return (s2.compare (s1) < 0) ? true : false;} +inline bool operator>= (const char8* s1, const ConstString& s2) {return (s2.compare (s1) <= 0) ? true : false;} +inline bool operator== (const char8* s1, const ConstString& s2) {return (s2.compare (s1) == 0) ? true : false;} +inline bool operator!= (const char8* s1, const ConstString& s2) {return (s2.compare (s1) != 0) ? true : false;} + +inline bool operator< (const ConstString& s1, const char16* s2) {return (s1.compare (s2) < 0) ? true : false;} +inline bool operator<= (const ConstString& s1, const char16* s2) {return (s1.compare (s2) <= 0) ? true : false;} +inline bool operator> (const ConstString& s1, const char16* s2) {return (s1.compare (s2) > 0) ? true : false;} +inline bool operator>= (const ConstString& s1, const char16* s2) {return (s1.compare (s2) >= 0) ? true : false;} +inline bool operator== (const ConstString& s1, const char16* s2) {return (s1.compare (s2) == 0) ? true : false;} +inline bool operator!= (const ConstString& s1, const char16* s2) {return (s1.compare (s2) != 0) ? true : false;} +inline bool operator< (const char16* s1, const ConstString& s2) {return (s2.compare (s1) > 0) ? true : false;} +inline bool operator<= (const char16* s1, const ConstString& s2) {return (s2.compare (s1) >= 0) ? true : false;} +inline bool operator> (const char16* s1, const ConstString& s2) {return (s2.compare (s1) < 0) ? true : false;} +inline bool operator>= (const char16* s1, const ConstString& s2) {return (s2.compare (s1) <= 0) ? true : false;} +inline bool operator== (const char16* s1, const ConstString& s2) {return (s2.compare (s1) == 0) ? true : false;} +inline bool operator!= (const char16* s1, const ConstString& s2) {return (s2.compare (s1) != 0) ? true : false;} + +// The following functions will only work with European Numbers! +// (e.g. Arabic, Tibetan, and Khmer digits are not supported) +extern int32 strnatcmp8 (const char8* s1, const char8* s2, bool caseSensitive = true); +extern int32 strnatcmp16 (const char16* s1, const char16* s2, bool caseSensitive = true); +inline int32 strnatcmp (const tchar* s1, const tchar* s2, bool caseSensitive = true) +{ +#ifdef UNICODE + return strnatcmp16 (s1, s2, caseSensitive); +#else + return strnatcmp8 (s1, s2, caseSensitive); +#endif +} + +//----------------------------------------------------------------------------- +/** StringObject implements IStringResult and IString methods. + It can therefore be exchanged with other Steinberg objects using one or both of these +interfaces. + +\see String, ConstString +*/ +//----------------------------------------------------------------------------- +class StringObject : public FObject, public String, public IStringResult, public IString +{ +public: +//----------------------------------------------------------------------------- + StringObject () {} + StringObject (const char16* str, int32 n = -1, bool isTerminated = true) : String (str, n, isTerminated) {} + StringObject (const char8* str, int32 n = -1, bool isTerminated = true) : String (str, n, isTerminated) {} + StringObject (const StringObject& str, int32 n = -1) : String (str, n) {} + StringObject (const String& str, int32 n = -1) : String (str, n) {} + StringObject (const FVariant& var) : String (var) {} + + using String::operator=; + + // IStringResult ---------------------------------------------------------- + virtual void PLUGIN_API setText (const char8* text) SMTG_OVERRIDE; + //------------------------------------------------------------------------- + + // IString----------------------------------------------------------------- + virtual void PLUGIN_API setText8 (const char8* text) SMTG_OVERRIDE; + virtual void PLUGIN_API setText16 (const char16* text) SMTG_OVERRIDE; + + virtual const char8* PLUGIN_API getText8 () SMTG_OVERRIDE; + virtual const char16* PLUGIN_API getText16 () SMTG_OVERRIDE; + + virtual void PLUGIN_API take (void* s, bool _isWide) SMTG_OVERRIDE; + virtual bool PLUGIN_API isWideString () const SMTG_OVERRIDE; + //------------------------------------------------------------------------- + + OBJ_METHODS (StringObject, FObject) + FUNKNOWN_METHODS2 (IStringResult, IString, FObject) +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/hexbinary.h b/VST3_SDK/base/source/hexbinary.h new file mode 100644 index 0000000000..85667d8201 --- /dev/null +++ b/VST3_SDK/base/source/hexbinary.h @@ -0,0 +1,130 @@ +//------------------------------------------------------------------------------------- +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/hexbinary.h +// Created by : Steinberg, 1/2012 +// Description : HexBinary encoding and decoding +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +//---------------------------------------------------------------------------------- +/** @file base/source/hexbinary.h + HexBinary encoding and decoding. */ +//---------------------------------------------------------------------------------- +#pragma once + +#include "base/source/fbuffer.h" + +namespace Steinberg { + +//------------------------------------------------------------------------------ +namespace HexBinary +{ + //------------------------------------------------------------------------------ + /** convert the HexBinary input buffer to binary. Note that it is appended to the result buffer. */ + //------------------------------------------------------------------------------ + inline bool decode (const void* input, int32 inputSize, Buffer& result) + { + if ((inputSize & 1) == 1) + return false; + + result.grow (result.getSize () + inputSize / 2); + + const char8* ptr = (const char8*)input; + uint8 current = 0; + for (int32 i = 0; i < inputSize; i++, ptr++) + { + current *= 16; + if (*ptr >= 48 && *ptr <= 57) // 0, 1, 2, .., 9 + { + current += *ptr - 48; + } + else if (*ptr >= 65 && *ptr <= 70) // A, B, .., F + { + current += *ptr - 55; + } + else if (*ptr >= 97 && *ptr <= 102) // a, b, .., f + { + current += *ptr - 87; + } + else + { + // malformed + return false; + } + if (i % 2) + { + if (result.put (current) == false) + return false; + current = 0; + } + } + return true; + } + + //------------------------------------------------------------------------------ + /** convert the binary input buffer to HexBinary. Note that it is appended to the result buffer. */ + //------------------------------------------------------------------------------ + inline bool encode (const void* input, int32 inputSize, Buffer& result) + { + result.grow (result.getSize () + inputSize * 2); + + const char8* ptr = (const char8*)input; + for (int32 i = 0; i < inputSize; i++, ptr++) + { + char8 high = (*ptr & 0xF0) >> 4; + char8 low = (*ptr & 0x0F); + if (high > 9) + { + if (result.put ((char8)(high + 55)) == false) + return false; + } + else + { + if (result.put ((char8)(high + 48)) == false) + return false; + } + if (low > 9) + { + if (result.put ((char8)(low + 55)) == false) + return false; + } + else + { + if (result.put ((char8)(low + 48)) == false) + return false; + } + } + return true; + } +//------------------------------------------------------------------------ +} // namespace HexBinary +} // namespace Steinberg diff --git a/VST3_SDK/base/source/timer.cpp b/VST3_SDK/base/source/timer.cpp new file mode 100644 index 0000000000..06733dc43b --- /dev/null +++ b/VST3_SDK/base/source/timer.cpp @@ -0,0 +1,329 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/timer.cpp +// Created by : Steinberg, 05/2006 +// Description : Timer class for receiving triggers at regular intervals +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "base/source/timer.h" + +namespace Steinberg { +static bool timersEnabled = true; + +//------------------------------------------------------------------------ +DisableDispatchingTimers::DisableDispatchingTimers () +{ + oldState = timersEnabled; + timersEnabled = false; +} + +//------------------------------------------------------------------------ +DisableDispatchingTimers::~DisableDispatchingTimers () +{ + timersEnabled = oldState; +} + +//------------------------------------------------------------------------ +namespace SystemTime { + +//------------------------------------------------------------------------ +struct ZeroStartTicks +{ + static const uint64 startTicks; + + static int32 getTicks32 () + { + return static_cast (SystemTime::getTicks64 () - startTicks); + } +}; +const uint64 ZeroStartTicks::startTicks = SystemTime::getTicks64 (); + +//------------------------------------------------------------------------ +int32 getTicks () +{ + return ZeroStartTicks::getTicks32 (); +} + +//------------------------------------------------------------------------ +} // namespace SystemTime +} // namespace Steinberg + + +#if MAC +#include +#include + +#ifdef verify +#undef verify +#endif + +namespace Steinberg { + +namespace SystemTime { + struct MachTimeBase { + private: + struct mach_timebase_info timebaseInfo; + + MachTimeBase () + { + mach_timebase_info (&timebaseInfo); + } + + static const MachTimeBase& instance () + { + static MachTimeBase gInstance; + return gInstance; + } + public: + static double getTimeNanos () + { + const MachTimeBase& timeBase = instance (); + double absTime = static_cast (mach_absolute_time ()); + double d = (absTime / timeBase.timebaseInfo.denom) * timeBase.timebaseInfo.numer; // nano seconds + return d; + } + }; + + //------------------------------------------------------------------------ + uint64 getTicks64 () + { + return static_cast (MachTimeBase::getTimeNanos () / 1000000.); + } +} // namespace SystemTime + +//------------------------------------------------------------------------ +class MacPlatformTimer : public Timer +{ +public: + MacPlatformTimer (ITimerCallback* callback, uint32 milliseconds); + ~MacPlatformTimer (); + + void stop (); + bool verify () const { return platformTimer != 0; } + + static void timerCallback (CFRunLoopTimerRef timer, void *info); +protected: + CFRunLoopTimerRef platformTimer; + ITimerCallback* callback; +}; + +//------------------------------------------------------------------------ +MacPlatformTimer::MacPlatformTimer (ITimerCallback* callback, uint32 milliseconds) +: platformTimer (0) +, callback (callback) +{ + if (callback) + { + CFRunLoopTimerContext timerContext = {0}; + timerContext.info = this; + platformTimer = CFRunLoopTimerCreate (kCFAllocatorDefault, CFAbsoluteTimeGetCurrent () + milliseconds * 0.001, milliseconds * 0.001f, 0, 0, timerCallback, &timerContext); + if (platformTimer) + CFRunLoopAddTimer (CFRunLoopGetMain (), platformTimer, kCFRunLoopCommonModes); + } +} + +//------------------------------------------------------------------------ +MacPlatformTimer::~MacPlatformTimer () +{ + stop (); +} + +//------------------------------------------------------------------------ +void MacPlatformTimer::stop () +{ + if (platformTimer) + { + CFRunLoopRemoveTimer (CFRunLoopGetMain (), platformTimer, kCFRunLoopCommonModes); + CFRelease (platformTimer); + platformTimer = 0; + } +} + +//------------------------------------------------------------------------ +void MacPlatformTimer::timerCallback (CFRunLoopTimerRef , void *info) +{ + if (timersEnabled) + { + MacPlatformTimer* timer = (MacPlatformTimer*)info; + if (timer) + { + timer->callback->onTimer (timer); + } + } +} + +//------------------------------------------------------------------------ +Timer* Timer::create (ITimerCallback* callback, uint32 milliseconds) +{ + MacPlatformTimer* timer = NEW MacPlatformTimer (callback, milliseconds); + if (timer->verify ()) + return timer; + timer->release (); + return 0; +} + +} + +#elif WINDOWS + +#include +#include +#include + +namespace Steinberg { +namespace SystemTime { +/* + @return the current system time in milliseconds +*/ +uint64 getTicks64 () +{ + return GetTickCount64 (); +} +} + +class WinPlatformTimer; +typedef std::list WinPlatformTimerList; + +//------------------------------------------------------------------------ +// WinPlatformTimer +//------------------------------------------------------------------------ +class WinPlatformTimer : public Timer +{ +public: +//------------------------------------------------------------------------ + WinPlatformTimer (ITimerCallback* callback, uint32 milliseconds); + ~WinPlatformTimer (); + + void stop (); + bool verify () const {return id != 0;} + +//------------------------------------------------------------------------ +private: + UINT_PTR id; + ITimerCallback* callback; + + static void addTimer (WinPlatformTimer* t); + static void removeTimer (WinPlatformTimer* t); + + static void CALLBACK TimerProc (HWND hwnd, UINT uMsg, UINT_PTR idEvent, DWORD dwTime); + static WinPlatformTimerList* timers; +}; + +//------------------------------------------------------------------------ +WinPlatformTimerList* WinPlatformTimer::timers = 0; + +//------------------------------------------------------------------------ +WinPlatformTimer::WinPlatformTimer (ITimerCallback* callback, uint32 milliseconds) +: callback (callback) +{ + id = SetTimer (0, 0, milliseconds, TimerProc); + if (id) + addTimer (this); +} + +//------------------------------------------------------------------------ +WinPlatformTimer::~WinPlatformTimer () +{ + stop (); +} + +//------------------------------------------------------------------------ +void WinPlatformTimer::addTimer (WinPlatformTimer* t) +{ + if (timers == 0) + timers = NEW WinPlatformTimerList; + timers->push_back (t); +} + +//------------------------------------------------------------------------ +void WinPlatformTimer::removeTimer (WinPlatformTimer* t) +{ + if (!timers) + return; + + WinPlatformTimerList::iterator it = std::find (timers->begin (), timers->end (), t); + if (it != timers->end ()) + timers->erase (it); + if (timers->empty ()) + { + delete timers; + timers = 0; + } +} + +//------------------------------------------------------------------------ +void WinPlatformTimer::stop () +{ + if (!id) + return; + + KillTimer (0, id); + removeTimer (this); + id = 0; +} + +//------------------------------------------------------------------------ +void CALLBACK WinPlatformTimer::TimerProc (HWND hwnd, UINT uMsg, UINT_PTR idEvent, DWORD dwTime) +{ + if (timersEnabled && timers) + { + WinPlatformTimerList::const_iterator it = timers->cbegin (); + while (it != timers->cend ()) + { + WinPlatformTimer* timer = *it; + if (timer->id == idEvent) + { + if (timer->callback) + timer->callback->onTimer (timer); + return; + } + } + } +} + +//------------------------------------------------------------------------ +Timer* Timer::create (ITimerCallback* callback, uint32 milliseconds) +{ + WinPlatformTimer* platformTimer = NEW WinPlatformTimer (callback, milliseconds); + if (platformTimer->verify ()) + return platformTimer; + platformTimer->release (); + return 0; +} + +//------------------------------------------------------------------------ +} // namespace Steinberg + +#elif LINUX +#warning DEPRECATED No Linux implementation +#endif diff --git a/VST3_SDK/base/source/timer.h b/VST3_SDK/base/source/timer.h new file mode 100644 index 0000000000..537202821f --- /dev/null +++ b/VST3_SDK/base/source/timer.h @@ -0,0 +1,165 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/timer.h +// Created by : Steinberg, 05/2006 +// Description : Timer class for receiving tiggers at regular intervals +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#pragma once + +#include "fobject.h" +#include + +namespace Steinberg { +class Timer; + +//------------------------------------------------------------------------ +namespace SystemTime { + +uint64 getTicks64 (); + +inline uint64 getTicksDuration (uint64 old, uint64 now) +{ + if (old > now) + return (std::numeric_limits::max) () - old + now; + return now - old; +} + +int32 getTicks (); ///< deprecated, use getTicks64 () + +//------------------------------------------------------------------------ +} // SystemTime + +//------------------------------------------------------------------------ +/** @class ITimerCallback + + + Implement this callback interface to receive triggers from a timer. + Note: This interface is intended as a mix-in class and therefore does not provide refcounting. + + + @see Timer */ +//------------------------------------------------------------------------ +class ITimerCallback +{ +public: + virtual ~ITimerCallback () {} + /** This method is called at the end of each interval. + + + \param timer The timer which calls. + */ + virtual void onTimer (Timer* timer) = 0; +}; + +template +ITimerCallback* newTimerCallback (const Call& call) +{ + struct Callback : public ITimerCallback + { + Callback (const Call& call) : call (call) {} + void onTimer (Timer* timer) SMTG_OVERRIDE { call (timer); } + Call call; + }; + return NEW Callback (call); +} + +// ----------------------------------------------------------------- +/** @class Timer + + Timer is a class that allows you to receive triggers at regular intervals. + + Note: The timer class is an abstract base class with (hidden) platform specific subclasses. + + + + Usage: + @code + class TimerReceiver : public FObject, public ITimerCallback + { + ... + virtual void onTimer (Timer* timer) + { + // do stuff + } + ... + }; + + TimerReceiver* receiver = new TimerReceiver (); + Timer* myTimer = Timer::create (receiver, 100); // interval: every 100ms + + + ... + ... + + if (myTimer) + myTimer->release (); + if (receiver) + receiver->release (); + @endcode + + @see ITimerCallback + */ +// ----------------------------------------------------------------- +class Timer : public FObject +{ +public: + /** Create a timer with a given interval + \param callback The receiver of the timer calls. + \param intervalMilliseconds The timer interval in milliseconds. + \return The created timer if any, callers owns the timer. The timer starts immediately. + */ + static Timer* create (ITimerCallback* callback, uint32 intervalMilliseconds); + + virtual void stop () = 0; ///< Stop the timer. +}; + +// ----------------------------------------------------------------- +/** @class DisableDispatchingTimers + + Disables dispatching of timers for the live time of this object + + */ +// ----------------------------------------------------------------- +class DisableDispatchingTimers +{ +public: + DisableDispatchingTimers (); + ~DisableDispatchingTimers (); + +private: + bool oldState; +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/updatehandler.cpp b/VST3_SDK/base/source/updatehandler.cpp new file mode 100644 index 0000000000..055dd6e512 --- /dev/null +++ b/VST3_SDK/base/source/updatehandler.cpp @@ -0,0 +1,667 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/updatehandler.cpp +// Created by : Steinberg, 2008 +// Description : +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#include "base/source/updatehandler.h" +#include "base/source/classfactoryhelpers.h" +#include "base/source/fstring.h" + +#include +#include +#include + +#define NON_EXISTING_DEPENDENCY_CHECK 0 // not now, mm +#define CLASS_NAME_TRACKED DEVELOPMENT + +namespace Steinberg { + +DEF_CLASS_IID (IUpdateManager) + +namespace Update { +const uint32 kHashSize = (1 << 8); // must be power of 2 (16 bytes * 256 == 4096) +const uint32 kMapSize = 1024 * 10; + +//------------------------------------------------------------------------ +inline uint32 hashPointer (void* p) +{ + return (uint32) ((uint64 (p) >> 12) & (kHashSize - 1)); +} + +//------------------------------------------------------------------------ +inline IPtr getUnknownBase (FUnknown* unknown) +{ + FUnknown* result = 0; + if (unknown) + unknown->queryInterface (FUnknown::iid, (void**)&result); + + return owned (result); +} + +#if CLASS_NAME_TRACKED +//------------------------------------------------------------------------ +struct Dependency +{ + Dependency (FUnknown* o = 0, IDependent* d = 0) : obj (o), dep (d), objClass (0), depClass (0) + { + } + + inline bool operator== (const Dependency& d) const { return obj == d.obj; } + inline bool operator!= (const Dependency& d) const { return obj != d.obj; } + inline bool operator< (const Dependency& d) const { return obj < d.obj; } + inline bool operator> (const Dependency& d) const { return obj > d.obj; } + FUnknown* obj; + IDependent* dep; + + FClassID objClass; + FClassID depClass; +}; +#endif + +//------------------------------------------------------------------------ +struct DeferedChange +{ + DeferedChange (FUnknown* o = 0, int32 m = 0) : obj (o), msg (m) {} + ~DeferedChange () {} + DeferedChange (const DeferedChange& r) : obj (r.obj), msg (r.msg) {} + inline bool operator== (const DeferedChange& d) const { return obj == d.obj; } + inline bool operator!= (const DeferedChange& d) const { return obj != d.obj; } + FUnknown* obj; + int32 msg; +}; + +//------------------------------------------------------------------------ +struct UpdateData +{ + UpdateData (FUnknown* o = 0, IDependent** d = 0, uint32 c = 0) + : obj (o), dependents (d), count (c) + { + } + FUnknown* obj; + IDependent** dependents; + uint32 count; + bool operator== (const UpdateData& d) const + { + return d.obj == obj && d.dependents == dependents; + } +}; + +//------------------------------------------------------------------------ +typedef std::list DeferedChangeList; +typedef DeferedChangeList::const_iterator DeferedChangeListIterConst; + +typedef std::list UpdateDataList; +typedef UpdateDataList::const_iterator UpdateDataListIterConst; + +#if CLASS_NAME_TRACKED +typedef std::list DependentList; +#else +typedef std::list DependentList; +#endif +typedef DependentList::iterator DependentListIter; +typedef DependentList::const_iterator DependentListIterConst; + +typedef std::map DependentMap; +typedef DependentMap::iterator DependentMapIter; +typedef DependentMap::const_iterator DependentMapIterConst; + +struct Table +{ + DependentMap depMap[kHashSize]; + DeferedChangeList defered; + UpdateDataList updateData; +}; + +//------------------------------------------------------------------------ +void updateDone (FUnknown* unknown, int32 message) +{ + if (message != IDependent::kDestroyed) + { + FObject* obj = FObject::unknownToObject (unknown); + if (obj) + obj->updateDone (message); + } +} +} + +//------------------------------------------------------------------------ +SINGLE_CREATE_FUNC (UpdateHandler) + +//------------------------------------------------------------------------ +static int32 countEntries (Update::DependentMap& map) +{ + int32 total = 0; + Update::DependentMapIterConst iterMap = map.begin (); + while (iterMap != map.end ()) + { + const Update::DependentList& list = iterMap->second; + Update::DependentListIterConst iterList = list.begin (); + while (iterList != list.end ()) + { + total++; + ++iterList; + } + ++iterMap; + } + return total; +} + +//------------------------------------------------------------------------ +UpdateHandler::UpdateHandler () : table (0) +{ + table = NEW Update::Table; + if (FObject::getUpdateHandler () == 0) + FObject::setUpdateHandler (this); +} + +//------------------------------------------------------------------------ +UpdateHandler::~UpdateHandler () +{ + if (FObject::getUpdateHandler () == this) + FObject::setUpdateHandler (0); + delete table; + table = 0; +} + +//------------------------------------------------------------------------ +tresult PLUGIN_API UpdateHandler::addDependent (FUnknown* u, IDependent* _dependent) +{ + IPtr unknown = Update::getUnknownBase (u); + if (!unknown || !_dependent) + return kResultFalse; + + FGuard guard (lock); + +#if CLASS_NAME_TRACKED + Update::Dependency dependent (unknown, _dependent); + + FObject* obj = FObject::unknownToObject (unknown); + if (obj) + dependent.objClass = obj->isA (); + obj = FObject::unknownToObject (_dependent); + if (obj) + dependent.depClass = obj->isA (); +#else + IDependent* dependent = _dependent; +#endif + + Update::DependentMap& map = table->depMap[Update::hashPointer (unknown)]; + Update::DependentMapIter it = map.find (unknown); + if (it == map.end ()) + { + Update::DependentList list; + list.push_back (dependent); + map[u] = list; + } + else + { + (*it).second.push_back (dependent); + } + + return kResultTrue; +} + +//------------------------------------------------------------------------ +tresult PLUGIN_API UpdateHandler::removeDependent (FUnknown* u, IDependent* dependent) +{ + IPtr unknown = Update::getUnknownBase (u); + if (unknown == 0 && dependent == 0) + return kResultFalse; + + FGuard guard (lock); + + Update::UpdateDataListIterConst iter = table->updateData.begin (); + while (iter != table->updateData.end ()) + { + if ((*iter).obj == unknown || unknown == 0) + { + for (uint32 count = 0; count < (*iter).count; count++) + { + if ((*iter).dependents[count] == dependent) + (*iter).dependents[count] = 0; + } + } + ++iter; + } + // Remove all objects for the given dependent + if (unknown == 0) + { + for (uint32 j = 0; j < Update::kHashSize; j++) + { + Update::DependentMap& map = table->depMap[j]; + Update::DependentMapIter iterMap = map.begin (); + while (iterMap != map.end ()) + { + Update::DependentList& list = (*iterMap).second; + Update::DependentListIter iterList = list.begin (); + while (iterList != list.end ()) + { + if ((*iterList) == dependent) + list.erase (iterList++); + else + ++iterList; + } + ++iterMap; + } + } + } + else + { + bool mustFlush = true; + + Update::DependentMap& map = table->depMap[Update::hashPointer (unknown)]; + Update::DependentMapIter iterList = map.find (unknown); + +#if NON_EXISTING_DEPENDENCY_CHECK + ASSERT (iterList != map.end () && "ERROR: Trying to remove a non existing dependency!") +#endif + if (iterList != map.end ()) + { + if (dependent == 0) // Remove all dependents of object + { + map.erase (iterList); + } + else // Remove one dependent + { + int32 eraseCount = 0; + Update::DependentList& dependentlist = (*iterList).second; + Update::DependentListIter iterDependentlist = dependentlist.begin (); + while (iterDependentlist != dependentlist.end ()) + { +#if CLASS_NAME_TRACKED + if ((*iterDependentlist).dep == dependent) +#else + if ((*iterDependentlist) == dependent) +#endif + { + dependentlist.erase (iterDependentlist++); + eraseCount++; + if (dependentlist.empty ()) + { + map.erase (iterList); + break; + } + } + else + { + ++iterDependentlist; + mustFlush = false; + } + } + } + } + if (mustFlush) + cancelUpdates (unknown); + } + + return kResultTrue; +} + +//------------------------------------------------------------------------ +tresult UpdateHandler::doTriggerUpdates (FUnknown* u, int32 message, bool suppressUpdateDone) +{ + IPtr unknown = Update::getUnknownBase (u); + if (!unknown) + return kResultFalse; + + // to avoid crashes due to stack overflow, we reduce the amount of memory reserved for the + // dependents + IDependent* smallDependents[Update::kMapSize / 10]; // 8kB for x64 + IDependent** dependents = smallDependents; + int32 maxDependents = Update::kMapSize / 10; + int32 count = 0; + + { + FGuard guard (lock); // scope for lock + + Update::DependentMap& map = table->depMap[Update::hashPointer (unknown)]; + Update::DependentMapIterConst iterList = map.find (unknown); + if (iterList != map.end ()) + { + const Update::DependentList& dependentlist = (*iterList).second; + Update::DependentListIterConst iterDependentlist = dependentlist.begin (); + while (iterDependentlist != dependentlist.end ()) + { +#if CLASS_NAME_TRACKED + dependents[count] = (*iterDependentlist).dep; +#else + dependents[count] = *iterDependentlist; +#endif + count++; + + if (count >= maxDependents) + { + if (dependents == smallDependents) + { + dependents = new IDependent*[Update::kMapSize]; + memcpy (dependents, smallDependents, count * sizeof (dependents[0])); + maxDependents = Update::kMapSize; + } + else + { + WARNING ("Dependency overflow") + break; + } + } + ++iterDependentlist; + } + } + + // push update data on the stack + if (count > 0) + { + Update::UpdateData data (unknown, dependents, count); + table->updateData.push_back (data); + } + } // end scope + + int32 i = 0; + while (i < count) + { + if (dependents[i]) + dependents[i]->update (unknown, message); + i++; + } + + if (dependents != smallDependents) + delete[] dependents; + + // remove update data from the stack + if (count > 0) + { + FGuard guard (lock); + + table->updateData.pop_back (); + } + + // send update done message + if (suppressUpdateDone == false) + Update::updateDone (unknown, message); + + return count > 0 ? kResultTrue : kResultFalse; // Object was found and has been updated +} + +//------------------------------------------------------------------------ +tresult PLUGIN_API UpdateHandler::triggerUpdates (FUnknown* u, int32 message) +{ + return doTriggerUpdates (u, message, false); +} + +//------------------------------------------------------------------------ +tresult PLUGIN_API UpdateHandler::deferUpdates (FUnknown* u, int32 message) +{ + IPtr unknown = Update::getUnknownBase (u); + if (!unknown) + return kResultFalse; + + FGuard guard (lock); + + Update::DependentMap& map = table->depMap[Update::hashPointer (unknown)]; + Update::DependentMapIterConst iterList = map.find (unknown); + + bool hasDependency = (iterList != map.end ()); + if (hasDependency == false) + { + Update::updateDone (unknown, message); + return kResultTrue; + } + + bool found = false; + Update::DeferedChangeListIterConst iter = table->defered.begin (); + while (iter != table->defered.end ()) + { + if ((*iter).obj == unknown && (*iter).msg == message) + { + found = true; + break; + } + ++iter; + } + + if (!found) + { + Update::DeferedChange change (unknown, message); + table->defered.push_back (change); + } + + return kResultTrue; +} + +//------------------------------------------------------------------------ +tresult PLUGIN_API UpdateHandler::triggerDeferedUpdates (FUnknown* unknown) +{ + Update::DeferedChangeList deferedAgain; + if (!unknown) + { + while (table->defered.empty () == false) + { + // Remove first from queue + lock.lock (); + + FUnknown* obj = table->defered.front ().obj; + int32 msg = table->defered.front ().msg; + table->defered.pop_front (); + + // check if this object is currently being updated. in this case, defer update again... + bool canSignal = true; + Update::UpdateDataListIterConst iter = table->updateData.begin (); + while (iter != table->updateData.end ()) + { + if ((*iter).obj == obj) + { + canSignal = false; + break; + } + ++iter; + } + lock.unlock (); + + if (canSignal) + { + triggerUpdates (obj, msg); + } + else + { + Update::DeferedChange change (obj, msg); + deferedAgain.push_back (change); + } + } + } + else + { + IPtr object = Update::getUnknownBase (unknown); + Update::DeferedChange tmp (object); + + while (true) + { + lock.lock (); + Update::DeferedChangeListIterConst it = + std::find (table->defered.begin (), table->defered.end (), tmp); + if (it == table->defered.end ()) + { + lock.unlock (); + return kResultTrue; + } + + if ((*it).obj != 0) + { + int32 msg = (*it).msg; + table->defered.erase (it); + + // check if this object is currently being updated. in this case, defer update + // again... + bool canSignal = true; + Update::UpdateDataListIterConst iter = table->updateData.begin (); + while (iter != table->updateData.end ()) + { + if ((*iter).obj == object) + { + canSignal = false; + break; + } + ++iter; + } + lock.unlock (); + + if (canSignal) + { + triggerUpdates (object, msg); + } + else + { + Update::DeferedChange change (object, msg); + deferedAgain.push_back (change); + } + } + } + } + + if (deferedAgain.empty () == false) + { + FGuard guard (lock); + + Update::DeferedChangeListIterConst iter = deferedAgain.begin (); + while (iter != deferedAgain.end ()) + { + table->defered.push_back (*iter); + ++iter; + } + } + + return kResultTrue; +} + +//------------------------------------------------------------------------ +tresult PLUGIN_API UpdateHandler::cancelUpdates (FUnknown* u) +{ + IPtr unknown = Update::getUnknownBase (u); + if (!unknown) + return kResultFalse; + + FGuard guard (lock); + + Update::DeferedChange change (unknown, 0); + table->defered.remove (change); + + return kResultTrue; +} + +#if DEVELOPMENT +//------------------------------------------------------------------------ +bool UpdateHandler::checkDeferred (FUnknown* object) +{ + IPtr unknown = Update::getUnknownBase (object); + + FGuard guard (lock); + + Update::DeferedChange tmp (unknown); + Update::DeferedChangeListIterConst it = + std::find (table->defered.begin (), table->defered.end (), tmp); + if (it != table->defered.end ()) + return true; + + return false; +} + +//------------------------------------------------------------------------ +bool UpdateHandler::hasDependencies (FUnknown* u) +{ + IPtr unknown = Update::getUnknownBase (u); + if (!unknown) + return false; + + FGuard guard (lock); + + Update::DependentMap& map = table->depMap[Update::hashPointer (unknown)]; + Update::DependentMapIterConst iterList = map.find (unknown); + bool hasDependency = (iterList != map.end ()); + + return hasDependency; +} + +//------------------------------------------------------------------------ +void UpdateHandler::printForObject (FObject* obj) const +{ + IPtr unknown = Update::getUnknownBase (obj); + if (!unknown) + return; + + FUnknownPtr dep (obj); + + bool header = false; + + Update::DependentMap& map = table->depMap[Update::hashPointer (unknown)]; + Update::DependentMapIterConst iterList = map.begin (); + while (iterList != map.end ()) + { + const Update::DependentList& dependentlist = (*iterList).second; + Update::DependentListIterConst iterDependentlist = dependentlist.begin (); + while (iterDependentlist != dependentlist.end ()) + { +#if CLASS_NAME_TRACKED + if ((*iterList).first == unknown || (*iterDependentlist).dep == dep.getInterface ()) + { + if (!header) + { + FDebugPrint ("Dependencies for object %8" FORMAT_INT64A " %s\n", (uint64)obj, + obj->isA ()); + header = true; + } + FDebugPrint ("%s %8" FORMAT_INT64A "\n <- %s %8" FORMAT_INT64A "\n", + (*iterDependentlist).depClass, (uint64) (*iterDependentlist).dep, + (*iterDependentlist).objClass, (uint64) ((*iterList).first)); + } +#else + if ((*iterList).first == unknown || (*iterDependentlist) == dep.getInterface ()) + { + if (!header) + { + FDebugPrint ("Dependencies for object %8" FORMAT_INT64A " %s\n", (uint64)obj, + obj->isA ()); + header = true; + } + FDebugPrint ("%8" FORMAT_INT64A "\n <- %8" FORMAT_INT64A "\n", + (uint64) (*iterDependentlist), (uint64) ((*iterList).first)); + } +#endif + } + + ++iterList; + } +} +#endif + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/base/source/updatehandler.h b/VST3_SDK/base/source/updatehandler.h new file mode 100644 index 0000000000..edd440dd46 --- /dev/null +++ b/VST3_SDK/base/source/updatehandler.h @@ -0,0 +1,131 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// Version : 1.0 +// +// Category : Helpers +// Filename : base/source/updatehandler.h +// Created by : Steinberg, 2008 +// Description : +// +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +// Redistribution and use in source and binary forms, with or without modification, +// are permitted provided that the following conditions are met: +// +// * Redistributions of source code must retain the above copyright notice, +// this list of conditions and the following disclaimer. +// * Redistributions in binary form must reproduce the above copyright notice, +// this list of conditions and the following disclaimer in the documentation +// and/or other materials provided with the distribution. +// * Neither the name of the Steinberg Media Technologies nor the names of its +// contributors may be used to endorse or promote products derived from this +// software without specific prior written permission. +// +// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +// IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +// INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +// OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +// OF THE POSSIBILITY OF SUCH DAMAGE. +//----------------------------------------------------------------------------- + +#pragma once + +#include "base/source/fobject.h" +#include "base/source/flock.h" +#include "pluginterfaces/base/iupdatehandler.h" + +namespace Steinberg { + +/// @cond ignore +namespace Update { struct Table; } +/// @endcond + +//------------------------------------------------------------------------ +/** Handle Send and Cancel pending message for a given object*/ +//------------------------------------------------------------------------ +class IUpdateManager : public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** cancel pending messages send by \param object or by any if object is 0 */ + virtual tresult PLUGIN_API cancelUpdates (FUnknown* object) = 0; + /** send pending messages send by \param object or by any if object is 0 */ + virtual tresult PLUGIN_API triggerDeferedUpdates (FUnknown* object = 0) = 0; + static const FUID iid; +}; + +DECLARE_CLASS_IID (IUpdateManager, 0x030B780C, 0xD6E6418D, 0x8CE00BC2, 0x09C834D4) + +//------------------------------------------------------------------------------ +/** +UpdateHandler implements IUpdateManager and IUpdateHandler to handle dependencies +between objects to store and forward messages to dependent objects. + +This implementation is thread save, so objects can send message, add or remove +dependents from different threads. +Do do so it uses mutex, so be aware of locking. +*/ +//------------------------------------------------------------------------------ +class UpdateHandler : public FObject, public IUpdateHandler, public IUpdateManager +{ +public: +//------------------------------------------------------------------------------ + UpdateHandler (); + ~UpdateHandler (); + + // IUpdateHandler + /** register \param dependent to get messages from \param object */ + virtual tresult PLUGIN_API addDependent (FUnknown* object, IDependent* dependent) SMTG_OVERRIDE; + /** unregister \param dependent to get no messages from \param object */ + virtual tresult PLUGIN_API removeDependent (FUnknown* object, + IDependent* dependent) SMTG_OVERRIDE; + /** send \param message to all dependents of \param object immediately */ + virtual tresult PLUGIN_API triggerUpdates (FUnknown* object, int32 message) SMTG_OVERRIDE; + /** send \param message to all dependents of \param object when idle */ + virtual tresult PLUGIN_API deferUpdates (FUnknown* object, int32 message) SMTG_OVERRIDE; + + // IUpdateManager + /** cancel pending messages send by \param object or by any if object is 0 */ + virtual tresult PLUGIN_API cancelUpdates (FUnknown* object) SMTG_OVERRIDE; + /** send pending messages send by \param object or by any if object is 0 */ + virtual tresult PLUGIN_API triggerDeferedUpdates (FUnknown* object = 0) SMTG_OVERRIDE; + + /// @cond ignore + // obsolete functions kept for compatibility + void checkUpdates (FObject* object = 0) { triggerDeferedUpdates (object->unknownCast ()); } + void flushUpdates (FObject* object) { cancelUpdates (object->unknownCast ()); } + void deferUpdate (FObject* object, int32 message) + { + deferUpdates (object->unknownCast (), message); + } + void signalChange (FObject* object, int32 message, bool suppressUpdateDone = false) + { + doTriggerUpdates (object->unknownCast (), message, suppressUpdateDone); + } +#if DEVELOPMENT + bool checkDeferred (FUnknown* object); + bool hasDependencies (FUnknown* object); + void printForObject (FObject* object) const; +#endif + /// @endcond + + OBJ_METHODS (UpdateHandler, FObject) + FUNKNOWN_METHODS2 (IUpdateHandler, IUpdateManager, FObject) + SINGLETON (UpdateHandler) +//------------------------------------------------------------------------------ +private: + tresult doTriggerUpdates (FUnknown* object, int32 message, bool suppressUpdateDone); + + FLock lock; + Update::Table* table; +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/cmake/modules/AddVST3Library.cmake b/VST3_SDK/cmake/modules/AddVST3Library.cmake new file mode 100644 index 0000000000..954be9049f --- /dev/null +++ b/VST3_SDK/cmake/modules/AddVST3Library.cmake @@ -0,0 +1,77 @@ + +# Output Directory for VST3 Plug-Ins +set(VST3_OUTPUT_DIR ${CMAKE_BINARY_DIR}/VST3) + +option(SMTG_RUN_VST_VALIDATOR "Run VST validator on VST3 plug-ins" ON) + +# Run the validator after building +function(smtg_run_vst_validator target) + add_dependencies(${target} validator) + if(WIN) + set(TARGET_PATH $) + elseif(XCODE) + set(TARGET_PATH "${VST3_OUTPUT_DIR}/${CMAKE_BUILD_TYPE}/${target}.vst3") + else() + set(TARGET_PATH "${VST3_OUTPUT_DIR}/${target}.vst3") + endif() + add_custom_command(TARGET ${target} POST_BUILD COMMAND $ "${TARGET_PATH}" WORKING_DIRECTORY "${CMAKE_RUNTIME_OUTPUT_DIRECTORY}") +endfunction() + +#------------------------------------------------------------------------------- +# VST3 Library Template +#------------------------------------------------------------------------------- +function(smtg_add_vst3plugin target sdkroot) + set(sources ${ARGN}) + if(MAC) + list(APPEND sources "${sdkroot}/public.sdk/source/main/macmain.cpp") + elseif(WIN) + list(APPEND sources "${sdkroot}/public.sdk/source/main/dllmain.cpp") + elseif(LINUX) + list(APPEND sources "${sdkroot}/public.sdk/source/main/linuxmain.cpp") + endif() + + add_library(${target} MODULE ${sources}) + set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY ${VST3_OUTPUT_DIR}) + + if(MAC) + set_target_properties(${target} PROPERTIES BUNDLE TRUE) + if(XCODE) + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_GENERATE_PKGINFO_FILE "YES") + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_WRAPPER_EXTENSION "vst3") + else() + set_target_properties(${target} PROPERTIES BUNDLE_EXTENSION "vst3") + endif() + smtg_set_exported_symbols(${target} "${sdkroot}/public.sdk/source/main/macexport.exp") + + target_link_libraries(${target} PRIVATE "-framework CoreFoundation") + elseif(WIN) + set_target_properties(${target} PROPERTIES SUFFIX ".vst3") + set_target_properties(${target} PROPERTIES LINK_FLAGS "/EXPORT:GetPluginFactory") + elseif(LINUX) + # ... + EXECUTE_PROCESS( COMMAND uname -m COMMAND tr -d '\n' OUTPUT_VARIABLE ARCHITECTURE ) + set(target_lib_dir ${ARCHITECTURE}-linux) + set_target_properties(${target} PROPERTIES PREFIX "") + set_target_properties(${target} PROPERTIES LIBRARY_OUTPUT_DIRECTORY "${VST3_OUTPUT_DIR}/${target}.vst3/Contents/${target_lib_dir}") + add_custom_command(TARGET ${target} PRE_LINK + COMMAND ${CMAKE_COMMAND} -E make_directory + "${VST3_OUTPUT_DIR}/${target}.vst3/Contents/Resources" + ) + endif() + if(SMTG_RUN_VST_VALIDATOR) + smtg_run_vst_validator(${target}) + endif() +endfunction() + +function(smtg_add_vst3_resource target input_file) + if (LINUX) + add_custom_command(TARGET ${target} POST_BUILD + COMMAND ${CMAKE_COMMAND} -E copy + "${CMAKE_CURRENT_LIST_DIR}/${input_file}" + "${VST3_OUTPUT_DIR}/${target}.vst3/Contents/Resources/" + ) + elseif(MAC) + target_sources(${target} PRIVATE ${input_file}) + set_source_files_properties(${input_file} PROPERTIES MACOSX_PACKAGE_LOCATION Resources) + endif(LINUX) +endfunction() diff --git a/VST3_SDK/cmake/modules/Bundle.cmake b/VST3_SDK/cmake/modules/Bundle.cmake new file mode 100644 index 0000000000..945eae80c9 --- /dev/null +++ b/VST3_SDK/cmake/modules/Bundle.cmake @@ -0,0 +1,55 @@ + +#------------------------------------------------------------------------------- +# Includes +#------------------------------------------------------------------------------- + +include(CMakeParseArguments) + +#------------------------------------------------------------------------------- +# Bundle configuration +#------------------------------------------------------------------------------- + +function(smtg_set_bundle target) + if(NOT MAC) + message(FATAL_ERROR "smtg_set_bundle only works on macOS, use it in an if(MAC) block") + endif() + + cmake_parse_arguments(ARG "PREPROCESS" "EXTENSION;INFOPLIST" "RESOURCES;PREPROCESSOR_FLAGS" ${ARGN}) + if(ARG_UNPARSED_ARGUMENTS) + message(FATAL_ERROR "The following parameters are unrecognized: ${ARG_UNPARSED_ARGUMENTS}") + endif() + + # Adding the bundle resources to the target sources creates a warning, see https://cmake.org/Bug/view.php?id=15272 + target_sources(${target} PRIVATE ${ARG_RESOURCES}) + + get_target_property(type ${target} TYPE) + if(type STREQUAL MODULE_LIBRARY) + set_target_properties(${target} PROPERTIES BUNDLE TRUE) + elseif(type STREQUAL EXECUTABLE) + set_target_properties(${target} PROPERTIES MACOSX_BUNDLE TRUE) + endif() + + if(ARG_EXTENSION) + if(XCODE) + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_WRAPPER_EXTENSION ${ARG_EXTENSION}) + else() + set_target_properties(${target} PROPERTIES BUNDLE_EXTENSION ${ARG_EXTENSION}) + endif() + endif() + + if(ARG_RESOURCES) + set_source_files_properties(${ARG_RESOURCES} PROPERTIES MACOSX_PACKAGE_LOCATION Resources) + endif() + + if(ARG_INFOPLIST) + if(XCODE) + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_INFOPLIST_FILE "${ARG_INFOPLIST}") + if(ARG_PREPROCESS) + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_INFOPLIST_PREPROCESS "YES") + endif() + if(ARG_PREPROCESSOR_FLAGS) + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_INFOPLIST_OTHER_PREPROCESSOR_FLAGS "${ARG_PREPROCESSOR_FLAGS}") + endif() + endif() + endif() +endfunction() diff --git a/VST3_SDK/cmake/modules/ExportedSymbols.cmake b/VST3_SDK/cmake/modules/ExportedSymbols.cmake new file mode 100644 index 0000000000..9d9a11edbb --- /dev/null +++ b/VST3_SDK/cmake/modules/ExportedSymbols.cmake @@ -0,0 +1,14 @@ + +#------------------------------------------------------------------------------- +# Exported Symbols +#------------------------------------------------------------------------------- + +function(smtg_set_exported_symbols target exported_symbols_file) + if(MSVC) + set_target_properties(${target} PROPERTIES LINK_FLAGS "/DEF:\"${exported_symbols_file}\"") + elseif(XCODE) + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_EXPORTED_SYMBOLS_FILE "${exported_symbols_file}") + else() + set_target_properties(${target} PROPERTIES LINK_FLAGS "-exported_symbols_list \"${exported_symbols_file}\"") + endif() +endfunction() diff --git a/VST3_SDK/cmake/modules/Global.cmake b/VST3_SDK/cmake/modules/Global.cmake new file mode 100644 index 0000000000..a9a2c3fafa --- /dev/null +++ b/VST3_SDK/cmake/modules/Global.cmake @@ -0,0 +1,102 @@ + +#------------------------------------------------------------------------------- +# Checks +#------------------------------------------------------------------------------- + +if(CMAKE_SOURCE_DIR STREQUAL CMAKE_BINARY_DIR OR EXISTS "${CMAKE_BINARY_DIR}/CMakeLists.txt") + message(SEND_ERROR "In-source builds are not allowed. Please create a separate build directory and run 'cmake /path/to/folder [options]' there.") + message(FATAL_ERROR "You can remove the file \"CMakeCache.txt\" and directory \"CMakeFiles\" in ${CMAKE_SOURCE_DIR}.") +endif() + +#------------------------------------------------------------------------------- +# CMake Policies +#------------------------------------------------------------------------------- + +if(POLICY CMP0054) + cmake_policy(SET CMP0054 NEW) +endif() + +#------------------------------------------------------------------------------- +# Platform Detection +#------------------------------------------------------------------------------- + +if(APPLE) + set(MAC TRUE) +elseif(WIN32) + set(WIN TRUE) +elseif(UNIX) + set(LINUX TRUE) +endif() + +#------------------------------------------------------------------------------- +# Global Settings +#------------------------------------------------------------------------------- + +if(WIN) + option(SMTG_USE_STATIC_CRT "Use static crt on Windows" OFF) +endif() + +set(CMAKE_BUILD_TYPE "Debug" CACHE STRING "Build type") + +if(LINUX) + set(common_linker_flags "-Wl,--no-undefined") + set(CMAKE_MODULE_LINKER_FLAGS "${common_linker_flags}" CACHE STRING "Module Library Linker Flags") + set(CMAKE_SHARED_LINKER_FLAGS "${common_linker_flags}" CACHE STRING "Shared Library Linker Flags") +endif() + +# Output directories +set(CMAKE_INSTALL_PREFIX "${CMAKE_BINARY_DIR}/dist") +set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib") +set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/lib") +set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}/bin") + +if(MAC) + # macOS defaults + if(NOT DEFINED ENV{MACOSX_DEPLOYMENT_TARGET}) + set(CMAKE_OSX_DEPLOYMENT_TARGET "10.8" CACHE STRING "macOS deployment target") + endif() + if(NOT DEFINED ENV{SDKROOT}) + execute_process(COMMAND xcrun --sdk macosx --show-sdk-path OUTPUT_VARIABLE CMAKE_OSX_SYSROOT OUTPUT_STRIP_TRAILING_WHITESPACE) + endif() + option(SMTG_BUILD_UNIVERSAL_BINARY "Build universal binary (32 & 64 bit)" OFF) + if(SMTG_BUILD_UNIVERSAL_BINARY) + set(CMAKE_OSX_ARCHITECTURES "x86_64;i386" CACHE STRING "macOS universal binary") + set(CMAKE_XCODE_ATTRIBUTE_ARCHS "$(ARCHS_STANDARD_32_64_BIT)") + set(CMAKE_XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH "$<$:YES>$<$:NO>") + endif() +endif() + +# Generation Settings +set(CMAKE_CONFIGURATION_TYPES "Debug;Release") +set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE STRING "Generate compile commands" FORCE) +set(CMAKE_SKIP_ASSEMBLY_SOURCE_RULES ON) +set(CMAKE_SKIP_INSTALL_RULES ON) +set(CMAKE_SKIP_PREPROCESSED_SOURCE_RULES ON) + +set_property(GLOBAL PROPERTY PREDEFINED_TARGETS_FOLDER Predefined) +set_property(GLOBAL PROPERTY USE_FOLDERS ON) + +add_compile_options($<$:-DDEVELOPMENT=1>) +add_compile_options($<$:-DRELEASE=1>) + +if(WIN) + add_compile_options(/MP) + add_compile_options($<$:/ZI>) + if(SMTG_USE_STATIC_CRT) + # /MTd = MultiThreaded Debug Runtime + # /MT = MultiThreaded Runtime + add_compile_options($<$:/MTd>) + add_compile_options($<$:/MT>) + else() + # /MDd = MultiThreadedDLL Debug Runtime + # /MD = MultiThreadedDLL Runtime + add_compile_options($<$:/MDd>) + add_compile_options($<$:/MD>) + endif() +endif() + +# Add colors to clang output when using Ninja +# See: https://github.com/ninja-build/ninja/wiki/FAQ +if (UNIX AND CMAKE_CXX_COMPILER_ID MATCHES "Clang" AND CMAKE_GENERATOR STREQUAL "Ninja") + add_compile_options(-fcolor-diagnostics) +endif() diff --git a/VST3_SDK/cmake/modules/PlatformIOS.cmake b/VST3_SDK/cmake/modules/PlatformIOS.cmake new file mode 100644 index 0000000000..cefad5451c --- /dev/null +++ b/VST3_SDK/cmake/modules/PlatformIOS.cmake @@ -0,0 +1,13 @@ + +#------------------------------------------------------------------------------- +# Platform +#------------------------------------------------------------------------------- + +function(smtg_set_platform_ios target) + if(NOT MAC) + message(FATAL_ERROR "smtg_set_platform_ios only works on macOS, use it in an if(MAC) block") + endif() + set_target_properties(${target} PROPERTIES OSX_ARCHITECTURES "armv7;arm64") + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_IPHONEOS_DEPLOYMENT_TARGET "8.0") + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_SDKROOT "iphoneos8.0") +endfunction() diff --git a/VST3_SDK/cmake/modules/PrefixHeader.cmake b/VST3_SDK/cmake/modules/PrefixHeader.cmake new file mode 100644 index 0000000000..06f82aeb3d --- /dev/null +++ b/VST3_SDK/cmake/modules/PrefixHeader.cmake @@ -0,0 +1,14 @@ + +#------------------------------------------------------------------------------- +# Prefix Header +#------------------------------------------------------------------------------- + +function(smtg_set_prefix_header target header precompile) + if(MSVC) + elseif(XCODE) + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_GCC_PREFIX_HEADER "${header}") + set_target_properties(${target} PROPERTIES XCODE_ATTRIBUTE_GCC_PRECOMPILE_PREFIX_HEADER "${precompile}") + else() + target_compile_options(${target} PRIVATE -include "${header}") + endif() +endfunction() diff --git a/VST3_SDK/index.html b/VST3_SDK/index.html new file mode 100644 index 0000000000..88cde23360 --- /dev/null +++ b/VST3_SDK/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/VST3_SDK/pluginterfaces/LICENSE.txt b/VST3_SDK/pluginterfaces/LICENSE.txt new file mode 100644 index 0000000000..e8af8518e0 --- /dev/null +++ b/VST3_SDK/pluginterfaces/LICENSE.txt @@ -0,0 +1,41 @@ +//----------------------------------------------------------------------------- +// LICENSE +// (c) 2017, Steinberg Media Technologies GmbH, All Rights Reserved +//----------------------------------------------------------------------------- +This license applies only to files referencing this license, +for other files of the Software Development Kit the respective embedded license text +is applicable. The license can be found at: www.steinberg.net/sdklicenses_vst3 + +This Software Development Kit is licensed under the terms of the Steinberg VST3 License, +or alternatively under the terms of the General Public License (GPL) Version 3. +You may use the Software Development Kit according to either of these licenses as it is +most appropriate for your project on a case-by-case basis (commercial or not). + +a) Proprietary Steinberg VST3 License +The Software Development Kit may not be distributed in parts or its entirety +without prior written agreement by Steinberg Media Technologies GmbH. +The SDK must not be used to re-engineer or manipulate any technology used +in any Steinberg or Third-party application or software module, +unless permitted by law. +Neither the name of the Steinberg Media Technologies GmbH nor the names of its +contributors may be used to endorse or promote products derived from this +software without specific prior written permission. +Before publishing a software under the proprietary license, you need to obtain a copy +of the License Agreement signed by Steinberg Media Technologies GmbH. +The Steinberg VST SDK License Agreement can be found at: +www.steinberg.net/en/company/developers.html + +THE SDK IS PROVIDED BY STEINBERG MEDIA TECHNOLOGIES GMBH "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL STEINBERG MEDIA TECHNOLOGIES GMBH BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, +BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF +LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE +OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED +OF THE POSSIBILITY OF SUCH DAMAGE. + +b) General Public License (GPL) Version 3 +Details of these licenses can be found at: www.gnu.org/licenses/gpl-3.0.html +//---------------------------------------------------------------------------------- diff --git a/VST3_SDK/pluginterfaces/base/conststringtable.cpp b/VST3_SDK/pluginterfaces/base/conststringtable.cpp new file mode 100644 index 0000000000..4891cefa15 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/conststringtable.cpp @@ -0,0 +1,106 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/conststringtable.cpp +// Created by : Steinberg, 09/2007 +// Description : constant unicode string table +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#include "conststringtable.h" +#include +#include + +namespace Steinberg { + +static std::map* stringMap; +static std::map* charMap; + +static char16* generateUTF16 (const char8* str); + +//---------------------------------------------------------------------------- +ConstStringTable* ConstStringTable::instance () +{ + static ConstStringTable stringTable; + return &stringTable; +} + +//---------------------------------------------------------------------------- +const char16* ConstStringTable::getString (const char8* str) const +{ + std::map::iterator iter = stringMap->find (str); + if (iter != stringMap->end ()) + return iter->second; + char16* uStr = generateUTF16 (str); + stringMap->insert (std::make_pair (str, uStr)); + return uStr; +} + +//---------------------------------------------------------------------------- +const char16 ConstStringTable::getString (const char8 str) const +{ + std::map::iterator iter = charMap->find (str); + if (iter != charMap->end ()) + return iter->second; + char16 uStr = 0; +#if BYTEORDER == kBigEndian + char8* puStr = (char8*)&uStr; + puStr[1] = str; +#else + uStr = str; +#endif + charMap->insert (std::make_pair (str, uStr)); + return uStr; +} + +//---------------------------------------------------------------------------- +ConstStringTable::ConstStringTable () +{ + stringMap = new std::map; + charMap = new std::map; +} + +//---------------------------------------------------------------------------- +ConstStringTable::~ConstStringTable () +{ + // free out allocated strings + { + std::map::iterator iter = stringMap->begin (); + while (iter != stringMap->end ()) + { + delete[] iter->second; + iter++; + } + } // delete iterator on map before deleting the map + + delete stringMap; + delete charMap; +} + +//---------------------------------------------------------------------------- +char16* generateUTF16 (const char8* str) +{ + int32 len = (int32)strlen (str); + char16* result = new char16[len + 1]; + for (int32 i = 0; i < len; i++) + { +#if BYTEORDER == kBigEndian + char8* pChr = (char8*)&result[i]; + pChr[0] = 0; + pChr[1] = str[i]; +#else + result[i] = str[i]; +#endif + } + result[len] = 0; + return result; +} +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/conststringtable.h b/VST3_SDK/pluginterfaces/base/conststringtable.h new file mode 100644 index 0000000000..177d32712a --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/conststringtable.h @@ -0,0 +1,45 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/conststringtable.h +// Created by : Steinberg, 09/2007 +// Description : constant unicode string table +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "ftypes.h" + +namespace Steinberg { + +//------------------------------------------------------------------------ +/** Constant unicode string table. +Used for conversion from ASCII string literals to char16. +*/ +//------------------------------------------------------------------------ +class ConstStringTable +{ +public: + static ConstStringTable* instance (); + + /** Returns a char16 string of a ASCII string literal*/ + const char16* getString (const char8* str) const; + /** Returns a char16 character of a ASCII character */ + const char16 getString (const char8 str) const; + +protected: + ConstStringTable (); + ~ConstStringTable (); +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg + diff --git a/VST3_SDK/pluginterfaces/base/falignpop.h b/VST3_SDK/pluginterfaces/base/falignpop.h new file mode 100644 index 0000000000..95fe62cf66 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/falignpop.h @@ -0,0 +1,29 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/falignpop.h +// Created by : Steinberg, 01/2004 +// Description : Restore alignment settings +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +//--------------------------------------------------------------------------------------------------- +#if TARGET_API_MAC_CARBON + #if PLATFORM_64 + #pragma pack(pop) + #else + #pragma options align=reset + #endif +#elif defined __BORLANDC__ + #pragma -a- +#elif WINDOWS + #pragma pack(pop) +#endif +//--------------------------------------------------------------------------------------------------- diff --git a/VST3_SDK/pluginterfaces/base/falignpush.h b/VST3_SDK/pluginterfaces/base/falignpush.h new file mode 100644 index 0000000000..68a732c19d --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/falignpush.h @@ -0,0 +1,34 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/falignpush.h +// Created by : Steinberg, 01/2004 +// Description : Set alignment settings +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +//---------------------------------------------------------------------------------------------- +#if TARGET_API_MAC_CARBON + #if PLATFORM_64 + #pragma pack(push, 16) + #else + #pragma options align=mac68k + #endif +#elif defined __BORLANDC__ + #pragma -a8 +#elif WINDOWS + #pragma pack(push) + #if PLATFORM_64 + #pragma pack(16) + #else + #pragma pack(8) + #endif +#endif +//---------------------------------------------------------------------------------------------- diff --git a/VST3_SDK/pluginterfaces/base/fplatform.h b/VST3_SDK/pluginterfaces/base/fplatform.h new file mode 100644 index 0000000000..b364b8b7b4 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/fplatform.h @@ -0,0 +1,147 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/fplatform.h +// Created by : Steinberg, 01/2004 +// Description : Detect platform and set define +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#define kLittleEndian 0 +#define kBigEndian 1 + +#undef PLUGIN_API + +#undef WINDOWS +#undef MAC + +//----------------------------------------------------------------------------- +// WIN32 AND WIN64 +#if defined (_WIN32) + #define WINDOWS 1 + #define BYTEORDER kLittleEndian + #define COM_COMPATIBLE 1 + #define PLUGIN_API __stdcall + + #ifndef _CRT_SECURE_NO_WARNINGS + #define _CRT_SECURE_NO_WARNINGS + #endif + + #pragma warning (disable : 4244) // Conversion from 'type1' to 'type2', possible loss of data. + #pragma warning (disable : 4250) // Inheritance via dominance is allowed + #pragma warning (disable : 4996) // deprecated functions + + #pragma warning (3 : 4189) // local variable is initialized but not referenced + #pragma warning (3 : 4238) // nonstandard extension used : class rvalue used as lvalue + + #if defined (_WIN64) // WIN64 only + #define PLATFORM_64 1 + #endif + #ifndef WIN32 + #define WIN32 1 + #endif + + #ifdef __cplusplus + #define SMTG_CPP11 __cplusplus >= 201103L || _MSC_VER > 1600 || __INTEL_CXX11_MODE__ + #define SMTG_CPP11_STDLIBSUPPORT SMTG_CPP11 + #endif +//----------------------------------------------------------------------------- +// LINUX +#elif __gnu_linux__ + #define LINUX 1 + #include + #if __BYTE_ORDER == __LITTLE_ENDIAN + #define BYTEORDER kLittleEndian + #else + #define BYTEORDER kBigEndian + #endif + #define COM_COMPATIBLE 0 + #define PLUGIN_API + #define PTHREADS 1 + #if __LP64__ + #define PLATFORM_64 1 + #endif + #ifdef __cplusplus + #include + #define SMTG_CPP11 (__cplusplus >= 201103L) + #ifndef SMTG_CPP11 + #error unsupported compiler + #endif + #define SMTG_CPP11_STDLIBSUPPORT 1 + #endif +//----------------------------------------------------------------------------- +// Mac and iOS +#elif __APPLE__ + #include + #define MAC 1 + #define PTHREADS 1 + #if !TARGET_OS_IPHONE + #ifndef __CF_USE_FRAMEWORK_INCLUDES__ + #define __CF_USE_FRAMEWORK_INCLUDES__ + #endif + #ifndef TARGET_API_MAC_CARBON + #define TARGET_API_MAC_CARBON 1 + #endif + #endif + #if __LP64__ + #define PLATFORM_64 1 + #endif + #if defined (__BIG_ENDIAN__) + #define BYTEORDER kBigEndian + #else + #define BYTEORDER kLittleEndian + #endif + #define COM_COMPATIBLE 0 + #define PLUGIN_API + + #if !defined(__PLIST__) && !defined(SMTG_DISABLE_DEFAULT_DIAGNOSTICS) + #ifdef __clang__ + #pragma GCC diagnostic ignored "-Wswitch-enum" + #pragma GCC diagnostic ignored "-Wparentheses" + #pragma GCC diagnostic ignored "-Wuninitialized" + #if __clang_major__ >= 3 + #pragma GCC diagnostic ignored "-Wtautological-compare" + #pragma GCC diagnostic ignored "-Wunused-value" + #if __clang_major__ >= 4 || __clang_minor__ >= 1 + #pragma GCC diagnostic ignored "-Wswitch" + #pragma GCC diagnostic ignored "-Wcomment" + #endif + #if __clang_major__ >= 5 + #pragma GCC diagnostic ignored "-Wunsequenced" + #if __clang_minor__ >= 1 + #pragma GCC diagnostic ignored "-Wunused-const-variable" + #endif + #endif + #endif + #endif + #endif + #ifdef __cplusplus + #include + #define SMTG_CPP11 (__cplusplus >= 201103L || __INTEL_CXX11_MODE__) + #if defined (_LIBCPP_VERSION) && SMTG_CPP11 + #define SMTG_CPP11_STDLIBSUPPORT 1 + #else + #define SMTG_CPP11_STDLIBSUPPORT 0 + #endif + #endif +#else + #pragma error unknown platform + +#endif +//----------------------------------------------------------------------------- + +//----------------------------------------------------------------------------- +#if SMTG_CPP11 +#define SMTG_OVERRIDE override +#else +#define SMTG_OVERRIDE +#endif diff --git a/VST3_SDK/pluginterfaces/base/fstrdefs.h b/VST3_SDK/pluginterfaces/base/fstrdefs.h new file mode 100644 index 0000000000..d49a910f13 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/fstrdefs.h @@ -0,0 +1,291 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/fstrdefs.h +// Created by : Steinberg, 01/2004 +// Description : Definitions for handling strings (Unicode / ASCII / Platforms) +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "ftypes.h" + +//---------------------------------------------------------------------------- +// string methods defines unicode / ASCII +//---------------------------------------------------------------------------- + +// 16 bit string operations +#if SMTG_CPP11 // if c++11 unicode string literals + #define SMTG_CPP11_CAT_PRIVATE_DONT_USE(a,b) a ## b + #if WINDOWS + #define STR16(x) SMTG_CPP11_CAT_PRIVATE_DONT_USE(L,x) + #else + #define STR16(x) SMTG_CPP11_CAT_PRIVATE_DONT_USE(u,x) + #endif +#else + #include "conststringtable.h" + #define STR16(x) Steinberg::ConstStringTable::instance ()->getString (x) +#endif + +#ifdef UNICODE + #define STR(x) STR16(x) + #define tStrBufferSize(buffer) (sizeof(buffer)/sizeof(Steinberg::tchar)) + +#else + #define STR(x) x + #define tStrBufferSize(buffer) (sizeof(buffer)) +#endif + +#define str8BufferSize(buffer) (sizeof(buffer)/sizeof(Steinberg::char8)) +#define str16BufferSize(buffer) (sizeof(buffer)/sizeof(Steinberg::char16)) + +#if WINDOWS +#define FORMAT_INT64A "I64d" +#define FORMAT_UINT64A "I64u" + +#elif MAC || LINUX +#define FORMAT_INT64A "lld" +#define FORMAT_UINT64A "llu" +#define stricmp strcasecmp +#define strnicmp strncasecmp +#endif + +#ifdef UNICODE +#define FORMAT_INT64W STR(FORMAT_INT64A) +#define FORMAT_UINT64W STR(FORMAT_UINT64A) + +#define FORMAT_INT64 FORMAT_INT64W +#define FORMAT_UINT64 FORMAT_UINT64W +#else +#define FORMAT_INT64 FORMAT_INT64A +#define FORMAT_UINT64 FORMAT_UINT64A +#endif + + +//---------------------------------------------------------------------------- +// newline +//---------------------------------------------------------------------------- +#if WINDOWS +#define ENDLINE_A "\r\n" +#define ENDLINE_W STR ("\r\n") +#elif MAC +#define ENDLINE_A "\r" +#define ENDLINE_W STR ("\r") +#elif LINUX +#define ENDLINE_A "\n" +#define ENDLINE_W STR ("\n") +#endif + +#ifdef UNICODE +#define ENDLINE ENDLINE_W +#else +#define ENDLINE ENDLINE_A +#endif + +#if WINDOWS && !defined(__GNUC__) && defined(_MSC_VER) && (_MSC_VER < 1900) +#define stricmp _stricmp +#define strnicmp _strnicmp +#define snprintf _snprintf +#endif + +namespace Steinberg { + +//---------------------------------------------------------------------------- +static const tchar kEmptyString[] = { 0 }; +static const char8 kEmptyString8[] = { 0 }; +static const char16 kEmptyString16[] = { 0 }; + +#ifdef UNICODE +static const tchar kInfiniteSymbol[] = { 0x221E, 0 }; +#else +static const tchar* const kInfiniteSymbol = STR ("oo"); +#endif + +//---------------------------------------------------------------------------- +template +inline int32 _tstrlen (const T* wcs) +{ + const T* eos = wcs; + + while (*eos++) + ; + + return (int32) (eos - wcs - 1); +} + +inline int32 tstrlen (const tchar* str) {return _tstrlen (str);} +inline int32 strlen8 (const char8* str) {return _tstrlen (str);} +inline int32 strlen16 (const char16* str) {return _tstrlen (str);} + +//---------------------------------------------------------------------------- +template +inline int32 _tstrcmp (const T* src, const T* dst) +{ + while (*src == *dst && *dst) + { + src++; + dst++; + } + + if (*src == 0 && *dst == 0) + return 0; + else if (*src == 0) + return -1; + else if (*dst == 0) + return 1; + else + return (int32) (*src - *dst); +} + +inline int32 tstrcmp (const tchar* src, const tchar* dst) {return _tstrcmp (src, dst);} +inline int32 strcmp8 (const char8* src, const char8* dst) {return _tstrcmp (src, dst);} +inline int32 strcmp16 (const char16* src, const char16* dst) {return _tstrcmp (src, dst);} + +template +inline int32 strcmpT (const T* first, const T* last); + +template <> +inline int32 strcmpT (const char8* first, const char8* last) { return _tstrcmp (first, last); } + +template <> +inline int32 strcmpT (const char16* first, const char16* last) { return _tstrcmp (first, last); } + +//---------------------------------------------------------------------------- +template +inline int32 _tstrncmp (const T* first, const T* last, uint32 count) +{ + if (count == 0) + return 0; + + while (--count && *first && *first == *last) + { + first++; + last++; + } + + if (*first == 0 && *last == 0) + return 0; + else if (*first == 0) + return -1; + else if (*last == 0) + return 1; + else + return (int32) (*first - *last); +} + +inline int32 tstrncmp (const tchar* first, const tchar* last, uint32 count) {return _tstrncmp (first, last, count);} +inline int32 strncmp8 (const char8* first, const char8* last, uint32 count) {return _tstrncmp (first, last, count);} +inline int32 strncmp16 (const char16* first, const char16* last, uint32 count) {return _tstrncmp (first, last, count);} + +template +inline int32 strncmpT (const T* first, const T* last, uint32 count); + +template <> +inline int32 strncmpT (const char8* first, const char8* last, uint32 count) { return _tstrncmp (first, last, count); } + +template <> +inline int32 strncmpT (const char16* first, const char16* last, uint32 count) {return _tstrncmp (first, last, count); } + +//---------------------------------------------------------------------------- +template +inline T* _tstrcpy (T* dst, const T* src) +{ + T* cp = dst; + while ((*cp++ = *src++) != 0) // copy string + ; + return dst; +} +inline tchar* tstrcpy (tchar* dst, const tchar* src) {return _tstrcpy (dst, src);} +inline char8* strcpy8 (char8* dst, const char8* src) {return _tstrcpy (dst, src);} +inline char16* strcpy16 (char16* dst, const char16* src) {return _tstrcpy (dst, src);} + +//---------------------------------------------------------------------------- +template +inline T* _tstrncpy (T* dest, const T* source, uint32 count) +{ + T* start = dest; + while (count && (*dest++ = *source++) != 0) // copy string + count--; + + if (count) // pad out with zeros + { + while (--count) + *dest++ = 0; + } + return start; +} + +inline tchar* tstrncpy (tchar* dest, const tchar* source, uint32 count) {return _tstrncpy (dest, source, count);} +inline char8* strncpy8 (char8* dest, const char8* source, uint32 count) {return _tstrncpy (dest, source, count);} +inline char16* strncpy16 (char16* dest, const char16* source, uint32 count) {return _tstrncpy (dest, source, count);} + +//---------------------------------------------------------------------------- +template +inline T* _tstrcat (T* dst, const T* src) +{ + T* cp = dst; + + while (*cp) + cp++; // find end of dst + + while ((*cp++ = *src++) != 0) // Copy src to end of dst + ; + + return dst; +} + +inline tchar* tstrcat (tchar* dst, const tchar* src) {return _tstrcat (dst, src); } +inline char8* strcat8 (char8* dst, const char8* src) {return _tstrcat (dst, src); } +inline char16* strcat16 (char16* dst, const char16* src) {return _tstrcat (dst, src); } + +//---------------------------------------------------------------------------- +inline void str8ToStr16 (char16* dst, const char8* src, int32 n = -1) +{ + int32 i = 0; + for (;;) + { + if (i == n) + { + dst[i] = 0; + return; + } + +#if BYTEORDER == kBigEndian + char8* pChr = (char8*)&dst[i]; + pChr[0] = 0; + pChr[1] = src[i]; +#else + dst[i] = src[i]; +#endif + + if (src[i] == 0) + break; + + i++; + } + + while (n > i) + { + dst[i] = 0; + i++; + } +} + +//------------------------------------------------------------------------ +inline bool FIDStringsEqual (FIDString id1, FIDString id2) +{ + return (id1 && id2) ? (strcmp8 (id1, id2) == 0) : false; +} + +static const uint32 kPrintfBufferSize = 4096; + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/ftypes.h b/VST3_SDK/pluginterfaces/base/ftypes.h new file mode 100644 index 0000000000..8634b98245 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/ftypes.h @@ -0,0 +1,192 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/ftypes.h +// Created by : Steinberg, 01/2004 +// Description : Basic data types +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "fplatform.h" + +//#define UNICODE_OFF // disable / enable unicode + +#ifdef UNICODE_OFF + #ifdef UNICODE + #undef UNICODE + #endif +#else + #define UNICODE 1 +#endif + +#ifdef UNICODE +#define _UNICODE 1 +#endif + +namespace Steinberg +{ +//----------------------------------------------------------------- +// Integral Types + typedef char int8; + typedef unsigned char uint8; + typedef unsigned char uchar; + + typedef short int16; + typedef unsigned short uint16; + +#if WINDOWS && !defined(__GNUC__) + typedef long int32; + typedef unsigned long uint32; +#else + typedef int int32; + typedef unsigned int uint32; +#endif + + static const int32 kMaxLong = 0x7fffffff; + static const int32 kMinLong = (-0x7fffffff - 1); + static const int32 kMaxInt32 = kMaxLong; + static const int32 kMinInt32 = kMinLong; + static const uint32 kMaxInt32u = 0xffffffff; + +#if WINDOWS && !defined(__GNUC__) + typedef __int64 int64; + typedef unsigned __int64 uint64; + static const int64 kMaxInt64 = 9223372036854775807i64; + static const int64 kMinInt64 = (-9223372036854775807i64 - 1); +#else + typedef long long int64; + typedef unsigned long long uint64; + static const int64 kMaxInt64 = 0x7fffffffffffffffLL; + static const int64 kMinInt64 = (-0x7fffffffffffffffLL-1); +#endif + static const uint64 kMaxInt64u = uint64 (0xffffffff) | (uint64 (0xffffffff) << 32); + +//----------------------------------------------------------------- +// other Semantic Types + typedef int64 TSize; // byte (or other) sizes + typedef int32 tresult; // result code +//----------------------------------------------------------------- + static const float kMaxFloat = 3.40282346638528860E38; + static const double kMaxDouble = 1.7976931348623158E308; + +#if PLATFORM_64 + typedef uint64 TPtrInt; +#else + typedef uint32 TPtrInt; +#endif + +//------------------------------------------------------------------ +// Boolean + typedef uint8 TBool; + +//------------------------------------------------------------------ +// Char / Strings + typedef char char8; +#ifdef _NATIVE_WCHAR_T_DEFINED + typedef __wchar_t char16; +#elif SMTG_CPP11 + typedef char16_t char16; +#else + typedef int16 char16; +#endif + +#ifdef UNICODE + typedef char16 tchar; +#else + typedef char8 tchar; +#endif + + typedef const char8* CStringA; + typedef const char16* CStringW; + typedef const tchar* CString; + inline bool strEmpty (const tchar* str) { return (!str || *str == 0); } + inline bool str8Empty (const char8* str) { return (!str || *str == 0); } + inline bool str16Empty (const char16* str) { return (!str || *str == 0); } + + typedef const char8* FIDString; // identifier as string (used for attributes, messages) + + const FIDString kPlatformStringWin = "WIN"; + const FIDString kPlatformStringMac = "MAC"; + const FIDString kPlatformStringIOS = "IOS"; + const FIDString kPlatformStringLinux = "Linux"; +#if WINDOWS + const FIDString kPlatformString = kPlatformStringWin; +#elif TARGET_OS_IPHONE + const FIDString kPlatformString = kPlatformStringIOS; +#elif MAC + const FIDString kPlatformString = kPlatformStringMac; +#elif LINUX + const FIDString kPlatformString = kPlatformStringLinux; +#endif + +//------------------------------------------------------------------------ +/** Coordinates */ + typedef int32 UCoord; + static const UCoord kMaxCoord = ((UCoord)0x7FFFFFFF); + static const UCoord kMinCoord = ((UCoord)-0x7FFFFFFF); +} // namespace Steinberg + + +//---------------------------------------------------------------------------- +/** Byte-order Conversion Macros */ +//---------------------------------------------------------------------------- +#define SWAP_32(l) { \ + unsigned char* p = (unsigned char*)& (l); \ + unsigned char t; \ + t = p[0]; p[0] = p[3]; p[3] = t; t = p[1]; p[1] = p[2]; p[2] = t; } + +#define SWAP_16(w) { \ + unsigned char* p = (unsigned char*)& (w); \ + unsigned char t; \ + t = p[0]; p[0] = p[1]; p[1] = t; } + +#define SWAP_64(i) { \ + unsigned char* p = (unsigned char*)& (i); \ + unsigned char t; \ + t = p[0]; p[0] = p[7]; p[7] = t; t = p[1]; p[1] = p[6]; p[6] = t; \ + t = p[2]; p[2] = p[5]; p[5] = t; t = p[3]; p[3] = p[4]; p[4] = t;} + +namespace Steinberg +{ + static inline void FSwap (int8&) {} + static inline void FSwap (uint8&) {} + static inline void FSwap (int16& i16) { SWAP_16 (i16) } + static inline void FSwap (uint16& i16) { SWAP_16 (i16) } + static inline void FSwap (int32& i32) { SWAP_32 (i32) } + static inline void FSwap (uint32& i32) { SWAP_32 (i32) } + static inline void FSwap (int64& i64) { SWAP_64 (i64) } + static inline void FSwap (uint64& i64) { SWAP_64 (i64) } +} + +// always inline macros (only when RELEASE is 1) +//---------------------------------------------------------------------------- +#if RELEASE + #if MAC || LINUX + #define SMTG_ALWAYS_INLINE __inline__ __attribute__((__always_inline__)) + #define SMTG_NEVER_INLINE __attribute__((noinline)) + #elif WINDOWS + #define SMTG_ALWAYS_INLINE __forceinline + #define SMTG_NEVER_INLINE __declspec(noinline) + #endif +#endif + +#ifndef SMTG_ALWAYS_INLINE + #define SMTG_ALWAYS_INLINE inline +#endif +#ifndef SMTG_NEVER_INLINE + #define SMTG_NEVER_INLINE +#endif + +#ifndef SMTG_CPP11_STDLIBSUPPORT +// Enable this for old compilers +// #define nullptr NULL +#endif diff --git a/VST3_SDK/pluginterfaces/base/funknown.cpp b/VST3_SDK/pluginterfaces/base/funknown.cpp new file mode 100644 index 0000000000..046acac601 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/funknown.cpp @@ -0,0 +1,475 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/funknown.cpp +// Created by : Steinberg, 01/2004 +// Description : Basic Interface +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#include "funknown.h" + +#include "fstrdefs.h" + +#include + +#if WINDOWS +#include +#endif + +#if MAC +#include +#include + +#if defined (__GNUC__) && (__GNUC__ >= 4) && !__LP64__ +// on 32 bit Mac OS X we can safely ignore the format warnings as sizeof(int) == sizeof(long) +#pragma GCC diagnostic ignored "-Wformat" +#endif + +#endif + +#if LINUX +#include +#endif + +namespace Steinberg { + +//------------------------------------------------------------------------ +#if COM_COMPATIBLE +#if WINDOWS +#define GuidStruct GUID +#else +struct GuidStruct +{ + uint32 Data1; + uint16 Data2; + uint16 Data3; + uint8 Data4[8]; +}; +#endif +#endif + +static void toString8 (char8* string, const char* data, int32 i1, int32 i2); +static void fromString8 (const char8* string, char* data, int32 i1, int32 i2); +static uint32 makeLong (uint8 b1, uint8 b2, uint8 b3, uint8 b4); + +//------------------------------------------------------------------------ +// FUnknownPrivate +//------------------------------------------------------------------------ +namespace FUnknownPrivate { +//------------------------------------------------------------------------ +int32 PLUGIN_API atomicAdd (int32& var, int32 d) +{ +#if WINDOWS + return InterlockedExchangeAdd (&var, d) + d; +#elif MAC + return OSAtomicAdd32Barrier (d, (int32_t*)&var); +#elif LINUX + __gnu_cxx::__atomic_add (&var, d); + return var; +#else +#warning implement me! + var += d; + return var; +#endif +} +} // FUnknownPrivate + +//------------------------------------------------------------------------ +// FUID implementation +//------------------------------------------------------------------------ + +FUID::FUID () +{ + memset (data, 0, sizeof (TUID)); +} + +//------------------------------------------------------------------------ +FUID::FUID (uint32 l1, uint32 l2, uint32 l3, uint32 l4) +{ + from4Int (l1, l2, l3, l4); +} + +//------------------------------------------------------------------------ +FUID::FUID (const FUID& f) +{ + memcpy (data, f.data, sizeof (TUID)); +} + +//------------------------------------------------------------------------ +#if SMTG_CPP11_STDLIBSUPPORT +FUID::FUID (FUID&& other) { + memcpy (data, other.data, sizeof (TUID)); +} + +FUID& FUID::operator= (FUID&& other) +{ + memcpy (data, other.data, sizeof (TUID)); + return *this; +} +#endif + +//------------------------------------------------------------------------ +bool FUID::generate () +{ +#if WINDOWS + GUID guid; + HRESULT hr = CoCreateGuid (&guid); + switch (hr) + { + case RPC_S_OK: + memcpy (data, (char*)&guid, sizeof (TUID)); + return true; + + case RPC_S_UUID_LOCAL_ONLY: + default: + return false; + } + +#elif MAC + CFUUIDRef uuid = CFUUIDCreate (kCFAllocatorDefault); + if (uuid) + { + CFUUIDBytes bytes = CFUUIDGetUUIDBytes (uuid); + memcpy (data, (char*)&bytes, sizeof (TUID)); + CFRelease (uuid); + return true; + } + return false; + +#else +#warning implement me! + return false; +#endif +} + +//------------------------------------------------------------------------ +bool FUID::isValid () const +{ + TUID nulluid = {0}; + + return memcmp (data, nulluid, sizeof (TUID)) != 0; +} + +//------------------------------------------------------------------------ +FUID& FUID::operator = (const FUID& f) +{ + memcpy (data, f.data, sizeof (TUID)); + return *this; +} + +//------------------------------------------------------------------------ +FUID& FUID::operator = (FIDString uid) +{ + memcpy (data, uid, sizeof (TUID)); + return *this; +} + +//------------------------------------------------------------------------ +FUID& FUID::operator = (TUID uid) +{ + memcpy (data, uid, sizeof (TUID)); + return *this; +} + + +//------------------------------------------------------------------------ +void FUID::from4Int (uint32 l1, uint32 l2, uint32 l3, uint32 l4) +{ +#if COM_COMPATIBLE + data [0] = (char)((l1 & 0x000000FF) ); + data [1] = (char)((l1 & 0x0000FF00) >> 8); + data [2] = (char)((l1 & 0x00FF0000) >> 16); + data [3] = (char)((l1 & 0xFF000000) >> 24); + data [4] = (char)((l2 & 0x00FF0000) >> 16); + data [5] = (char)((l2 & 0xFF000000) >> 24); + data [6] = (char)((l2 & 0x000000FF) ); + data [7] = (char)((l2 & 0x0000FF00) >> 8); + data [8] = (char)((l3 & 0xFF000000) >> 24); + data [9] = (char)((l3 & 0x00FF0000) >> 16); + data [10] = (char)((l3 & 0x0000FF00) >> 8); + data [11] = (char)((l3 & 0x000000FF) ); + data [12] = (char)((l4 & 0xFF000000) >> 24); + data [13] = (char)((l4 & 0x00FF0000) >> 16); + data [14] = (char)((l4 & 0x0000FF00) >> 8); + data [15] = (char)((l4 & 0x000000FF) ); +#else + data [0] = (char)((l1 & 0xFF000000) >> 24); + data [1] = (char)((l1 & 0x00FF0000) >> 16); + data [2] = (char)((l1 & 0x0000FF00) >> 8); + data [3] = (char)((l1 & 0x000000FF) ); + data [4] = (char)((l2 & 0xFF000000) >> 24); + data [5] = (char)((l2 & 0x00FF0000) >> 16); + data [6] = (char)((l2 & 0x0000FF00) >> 8); + data [7] = (char)((l2 & 0x000000FF) ); + data [8] = (char)((l3 & 0xFF000000) >> 24); + data [9] = (char)((l3 & 0x00FF0000) >> 16); + data [10] = (char)((l3 & 0x0000FF00) >> 8); + data [11] = (char)((l3 & 0x000000FF) ); + data [12] = (char)((l4 & 0xFF000000) >> 24); + data [13] = (char)((l4 & 0x00FF0000) >> 16); + data [14] = (char)((l4 & 0x0000FF00) >> 8); + data [15] = (char)((l4 & 0x000000FF) ); +#endif +} + +//------------------------------------------------------------------------ +void FUID::to4Int (uint32& d1, uint32& d2, uint32& d3, uint32& d4) const +{ + d1 = getLong1 (); + d2 = getLong2 (); + d3 = getLong3 (); + d4 = getLong4 (); +} + +//------------------------------------------------------------------------ +uint32 FUID::getLong1 () const +{ +#if COM_COMPATIBLE + return makeLong (data[3], data[2], data [1], data [0]); +#else + return makeLong (data[0], data[1], data [2], data [3]); +#endif +} + +//------------------------------------------------------------------------ +uint32 FUID::getLong2 () const +{ +#if COM_COMPATIBLE + return makeLong (data[5], data[4], data [7], data [6]); +#else + return makeLong (data[4], data[5], data [6], data [7]); +#endif +} + +//------------------------------------------------------------------------ +uint32 FUID::getLong3 () const +{ +#if COM_COMPATIBLE + return makeLong (data[8], data[9], data [10], data [11]); +#else + return makeLong (data[8], data[9], data [10], data [11]); +#endif +} + +//------------------------------------------------------------------------ +uint32 FUID::getLong4 () const +{ +#if COM_COMPATIBLE + return makeLong (data[12], data[13], data [14], data [15]); +#else + return makeLong (data[12], data[13], data [14], data [15]); +#endif +} + +//------------------------------------------------------------------------ +void FUID::toString (char8* string) const +{ + if (!string) + return; + + #if COM_COMPATIBLE + GuidStruct* g = (GuidStruct*)data; + + char8 s[17]; + Steinberg::toString8 (s, data, 8, 16); + + sprintf (string, "%08X%04X%04X%s", g->Data1, g->Data2, g->Data3, s); + #else + Steinberg::toString8 (string, data, 0, 16); + #endif +} + +//------------------------------------------------------------------------ +bool FUID::fromString (const char8* string) +{ + if (!string || !*string) + return false; + if (strlen (string) != 32) + return false; + + #if COM_COMPATIBLE + GuidStruct g; + char s[33]; + + strcpy (s, string); + s[8] = 0; + sscanf (s, "%x", &g.Data1); + strcpy (s, string + 8); + s[4] = 0; + sscanf (s, "%hx", &g.Data2); + strcpy (s, string + 12); + s[4] = 0; + sscanf (s, "%hx", &g.Data3); + + memcpy (data, &g, 8); + Steinberg::fromString8 (string + 16, data, 8, 16); + #else + Steinberg::fromString8 (string, data, 0, 16); + #endif + + return true; +} + +//------------------------------------------------------------------------ +bool FUID::fromRegistryString (const char8* string) +{ + if (!string || !*string) + return false; + if (strlen (string) != 38) + return false; + + // e.g. {c200e360-38c5-11ce-ae62-08002b2b79ef} + + #if COM_COMPATIBLE + GuidStruct g; + char8 s[10]; + + strncpy (s, string + 1, 8); + s[8] = 0; + sscanf (s, "%x", &g.Data1); + strncpy (s, string + 10, 4); + s[4] = 0; + sscanf (s, "%hx", &g.Data2); + strncpy (s, string + 15, 4); + s[4] = 0; + sscanf (s, "%hx", &g.Data3); + memcpy (data, &g, 8); + + Steinberg::fromString8 (string + 20, data, 8, 10); + Steinberg::fromString8 (string + 25, data, 10, 16); + #else + Steinberg::fromString8 (string + 1, data, 0, 4); + Steinberg::fromString8 (string + 10, data, 4, 6); + Steinberg::fromString8 (string + 15, data, 6, 8); + Steinberg::fromString8 (string + 20, data, 8, 10); + Steinberg::fromString8 (string + 25, data, 10, 16); + #endif + + return true; +} + +//------------------------------------------------------------------------ +void FUID::toRegistryString (char8* string) const +{ + // e.g. {c200e360-38c5-11ce-ae62-08002b2b79ef} + + #if COM_COMPATIBLE + GuidStruct* g = (GuidStruct*)data; + + char8 s1[5]; + Steinberg::toString8 (s1, data, 8, 10); + + char8 s2[13]; + Steinberg::toString8 (s2, data, 10, 16); + + sprintf (string, "{%08X-%04X-%04X-%s-%s}", g->Data1, g->Data2, g->Data3, s1, s2); + #else + char8 s1[9]; + Steinberg::toString8 (s1, data, 0, 4); + char8 s2[5]; + Steinberg::toString8 (s2, data, 4, 6); + char8 s3[5]; + Steinberg::toString8 (s3, data, 6, 8); + char8 s4[5]; + Steinberg::toString8 (s4, data, 8, 10); + char8 s5[13]; + Steinberg::toString8 (s5, data, 10, 16); + + sprintf (string, "{%s-%s-%s-%s-%s}", s1, s2, s3, s4, s5); + #endif +} + +//------------------------------------------------------------------------ +void FUID::print (char8* string, int32 style) const +{ + if (!string) // no string: debug output + { + char8 str [128]; + print (str, style); + + #if WINDOWS + OutputDebugStringA (str); + OutputDebugStringA ("\n"); + #else + fprintf (stdout, "%s\n", str); + #endif + return; + } + + uint32 l1, l2, l3, l4; + to4Int (l1, l2, l3, l4); + + switch (style) + { + case kINLINE_UID: + sprintf (string, "INLINE_UID (0x%08X, 0x%08X, 0x%08X, 0x%08X)", l1, l2, l3, l4); + break; + + case kDECLARE_UID: + sprintf (string, "DECLARE_UID (0x%08X, 0x%08X, 0x%08X, 0x%08X)", l1, l2, l3, l4); + break; + + case kFUID: + sprintf (string, "FUID (0x%08X, 0x%08X, 0x%08X, 0x%08X)", l1, l2, l3, l4); + break; + + case kCLASS_UID: + default: + sprintf (string, "DECLARE_CLASS_IID (Interface, 0x%08X, 0x%08X, 0x%08X, 0x%08X)", l1, l2, l3, l4); + break; + } +} + +//------------------------------------------------------------------------ +void FUID::toTUID (TUID result) const +{ + memcpy (result, data, sizeof (TUID)); +} + + +//------------------------------------------------------------------------ +// helpers +//------------------------------------------------------------------------ +static uint32 makeLong (uint8 b1, uint8 b2, uint8 b3, uint8 b4) +{ + return (uint32(b1) << 24) | (uint32(b2) << 16) | (uint32(b3) << 8) | uint32(b4); +} + +//------------------------------------------------------------------------ +static void toString8 (char8* string, const char* data, int32 i1, int32 i2) +{ + *string = 0; + for (int32 i = i1; i < i2; i++) + { + char8 s[3]; + sprintf (s, "%02X", (uint8)data[i]); + strcat (string, s); + } +} + +//------------------------------------------------------------------------ +static void fromString8 (const char8* string, char* data, int32 i1, int32 i2) +{ + for (int32 i = i1; i < i2; i++) + { + char8 s[3]; + s[0] = *string++; + s[1] = *string++; + s[2] = 0; + + int32 d = 0; + sscanf (s, "%2x", &d); + data[i] = (char)d; + } +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/funknown.h b/VST3_SDK/pluginterfaces/base/funknown.h new file mode 100644 index 0000000000..a2804418a8 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/funknown.h @@ -0,0 +1,456 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/funknown.h +// Created by : Steinberg, 01/2004 +// Description : Basic Interface +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/fplatform.h" +#include "pluginterfaces/base/ftypes.h" +#include "pluginterfaces/base/smartpointer.h" +#include + +//------------------------------------------------------------------------ +/*! \defgroup pluginBase Basic Interfaces +*/ +//------------------------------------------------------------------------ + +//------------------------------------------------------------------------ +// Unique Identifier macros +//------------------------------------------------------------------------ + +#if COM_COMPATIBLE +#define INLINE_UID(l1, l2, l3, l4) \ +{ \ + (::Steinberg::int8)((l1 & 0x000000FF) ), (::Steinberg::int8)((l1 & 0x0000FF00) >> 8), \ + (::Steinberg::int8)((l1 & 0x00FF0000) >> 16), (::Steinberg::int8)((l1 & 0xFF000000) >> 24), \ + (::Steinberg::int8)((l2 & 0x00FF0000) >> 16), (::Steinberg::int8)((l2 & 0xFF000000) >> 24), \ + (::Steinberg::int8)((l2 & 0x000000FF) ), (::Steinberg::int8)((l2 & 0x0000FF00) >> 8), \ + (::Steinberg::int8)((l3 & 0xFF000000) >> 24), (::Steinberg::int8)((l3 & 0x00FF0000) >> 16), \ + (::Steinberg::int8)((l3 & 0x0000FF00) >> 8), (::Steinberg::int8)((l3 & 0x000000FF) ), \ + (::Steinberg::int8)((l4 & 0xFF000000) >> 24), (::Steinberg::int8)((l4 & 0x00FF0000) >> 16), \ + (::Steinberg::int8)((l4 & 0x0000FF00) >> 8), (::Steinberg::int8)((l4 & 0x000000FF) ) \ +} +#else +#define INLINE_UID(l1, l2, l3, l4) \ +{ \ + (::Steinberg::int8)((l1 & 0xFF000000) >> 24), (::Steinberg::int8)((l1 & 0x00FF0000) >> 16), \ + (::Steinberg::int8)((l1 & 0x0000FF00) >> 8), (::Steinberg::int8)((l1 & 0x000000FF) ), \ + (::Steinberg::int8)((l2 & 0xFF000000) >> 24), (::Steinberg::int8)((l2 & 0x00FF0000) >> 16), \ + (::Steinberg::int8)((l2 & 0x0000FF00) >> 8), (::Steinberg::int8)((l2 & 0x000000FF) ), \ + (::Steinberg::int8)((l3 & 0xFF000000) >> 24), (::Steinberg::int8)((l3 & 0x00FF0000) >> 16), \ + (::Steinberg::int8)((l3 & 0x0000FF00) >> 8), (::Steinberg::int8)((l3 & 0x000000FF) ), \ + (::Steinberg::int8)((l4 & 0xFF000000) >> 24), (::Steinberg::int8)((l4 & 0x00FF0000) >> 16), \ + (::Steinberg::int8)((l4 & 0x0000FF00) >> 8), (::Steinberg::int8)((l4 & 0x000000FF) ) \ +} +#endif + +//------------------------------------------------------------------------ +#define DECLARE_UID(name, l1, l2, l3, l4) \ + ::Steinberg::TUID name = INLINE_UID (l1, l2, l3, l4); + +//------------------------------------------------------------------------ +#define EXTERN_UID(name) \ + extern const ::Steinberg::TUID name; + + +#ifdef INIT_CLASS_IID +#define DECLARE_CLASS_IID(ClassName, l1, l2, l3, l4) static const ::Steinberg::TUID ClassName##_iid = INLINE_UID (l1, l2, l3, l4); \ +const ::Steinberg::FUID ClassName::iid (ClassName##_iid); +#else +#define DECLARE_CLASS_IID(ClassName, l1, l2, l3, l4) static const ::Steinberg::TUID ClassName##_iid = INLINE_UID (l1, l2, l3, l4); +#endif +#define DEF_CLASS_IID(ClassName) const ::Steinberg::FUID ClassName::iid (ClassName##_iid); + +#define INLINE_UID_OF(ClassName) ClassName##_iid + +#define INLINE_UID_FROM_FUID(x) INLINE_UID(x.getLong1 (), x.getLong2 (), x.getLong3 (), x.getLong4 ()) + +//------------------------------------------------------------------------ +// FUnknown implementation macros +//------------------------------------------------------------------------ + +#define DECLARE_FUNKNOWN_METHODS \ +public: \ + virtual ::Steinberg::tresult PLUGIN_API queryInterface (const ::Steinberg::TUID _iid, void** obj) SMTG_OVERRIDE; \ + virtual ::Steinberg::uint32 PLUGIN_API addRef () SMTG_OVERRIDE; \ + virtual ::Steinberg::uint32 PLUGIN_API release () SMTG_OVERRIDE; \ +protected : \ + ::Steinberg::int32 __funknownRefCount; \ +public: + +//------------------------------------------------------------------------ + +#define DELEGATE_REFCOUNT(ClassName) \ +public: \ + virtual ::Steinberg::uint32 PLUGIN_API addRef () SMTG_OVERRIDE { return ClassName::addRef (); } \ + virtual ::Steinberg::uint32 PLUGIN_API release () SMTG_OVERRIDE { return ClassName::release (); } + +//------------------------------------------------------------------------ +#define IMPLEMENT_REFCOUNT(ClassName) \ +::Steinberg::uint32 PLUGIN_API ClassName::addRef () \ +{ \ + return ::Steinberg::FUnknownPrivate::atomicAdd (__funknownRefCount, 1); \ +} \ +::Steinberg::uint32 PLUGIN_API ClassName::release () \ +{ \ + if (::Steinberg::FUnknownPrivate::atomicAdd (__funknownRefCount, -1) == 0) \ + { \ + delete this; \ + return 0; \ + } \ + return __funknownRefCount; \ +} + +//------------------------------------------------------------------------ +#define FUNKNOWN_CTOR { __funknownRefCount = 1; } +#define FUNKNOWN_DTOR + +//------------------------------------------------------------------------ +#define QUERY_INTERFACE(iid, obj, InterfaceIID, InterfaceName) \ +if (::Steinberg::FUnknownPrivate::iidEqual (iid, InterfaceIID)) \ +{ \ + addRef (); \ + *obj = static_cast< InterfaceName* >(this); \ + return ::Steinberg::kResultOk; \ +} + +//------------------------------------------------------------------------ +#define IMPLEMENT_QUERYINTERFACE(ClassName, InterfaceName, ClassIID) \ +::Steinberg::tresult PLUGIN_API ClassName::queryInterface (const ::Steinberg::TUID _iid, void** obj) \ +{ \ + QUERY_INTERFACE (_iid, obj, ::Steinberg::FUnknown::iid, InterfaceName) \ + QUERY_INTERFACE (_iid, obj, ClassIID, InterfaceName) \ + *obj = nullptr; \ + return ::Steinberg::kNoInterface; \ +} + +//------------------------------------------------------------------------ +#define IMPLEMENT_FUNKNOWN_METHODS(ClassName,InterfaceName,ClassIID) \ + IMPLEMENT_REFCOUNT (ClassName) \ + IMPLEMENT_QUERYINTERFACE (ClassName, InterfaceName, ClassIID) + +//------------------------------------------------------------------------ +// Result Codes +//------------------------------------------------------------------------ + +namespace Steinberg { + +//------------------------------------------------------------------------ +#if COM_COMPATIBLE +#if WINDOWS +enum +{ + kNoInterface = static_cast(0x80004002L), // E_NOINTERFACE + kResultOk = static_cast(0x00000000L), // S_OK + kResultTrue = kResultOk, + kResultFalse = static_cast(0x00000001L), // S_FALSE + kInvalidArgument = static_cast(0x80070057L), // E_INVALIDARG + kNotImplemented = static_cast(0x80004001L), // E_NOTIMPL + kInternalError = static_cast(0x80004005L), // E_FAIL + kNotInitialized = static_cast(0x8000FFFFL), // E_UNEXPECTED + kOutOfMemory = static_cast(0x8007000EL) // E_OUTOFMEMORY +}; +#else +enum +{ + kNoInterface = static_cast(0x80000004L), // E_NOINTERFACE + kResultOk = static_cast(0x00000000L), // S_OK + kResultTrue = kResultOk, + kResultFalse = static_cast(0x00000001L), // S_FALSE + kInvalidArgument = static_cast(0x80000003L), // E_INVALIDARG + kNotImplemented = static_cast(0x80000001L), // E_NOTIMPL + kInternalError = static_cast(0x80000008L), // E_FAIL + kNotInitialized = static_cast(0x8000FFFFL), // E_UNEXPECTED + kOutOfMemory = static_cast(0x80000002L) // E_OUTOFMEMORY +}; +#endif +#else +enum +{ + kNoInterface = -1, + kResultOk, + kResultTrue = kResultOk, + kResultFalse, + kInvalidArgument, + kNotImplemented, + kInternalError, + kNotInitialized, + kOutOfMemory +}; +#endif + +//------------------------------------------------------------------------ +typedef int64 LARGE_INT; // obsolete + +//------------------------------------------------------------------------ +// FUID class declaration +//------------------------------------------------------------------------ +typedef int8 TUID[16]; ///< plain UID type + +//------------------------------------------------------------------------ +/* FUnknown private */ +namespace FUnknownPrivate { +SMTG_ALWAYS_INLINE bool iidEqual (const void* iid1, const void* iid2) +{ + const uint64* p1 = reinterpret_cast (iid1); + const uint64* p2 = reinterpret_cast (iid2); + return p1[0] == p2[0] && p1[1] == p2[1]; +} + +int32 PLUGIN_API atomicAdd (int32& value, int32 amount); +} + +//------------------------------------------------------------------------ +/** Handling 16 Byte Globaly Unique Identifiers. +\ingroup pluginBase + +Each interface declares its identifier as static member inside the interface +namespace (e.g. FUnknown::iid). +*/ +//------------------------------------------------------------------------ +class FUID +{ +public: +//------------------------------------------------------------------------ + FUID (); + inline FUID (const TUID uid); + FUID (uint32 l1, uint32 l2, uint32 l3, uint32 l4); + FUID (const FUID&); + virtual ~FUID () {} + +#if SMTG_CPP11_STDLIBSUPPORT + FUID (FUID&& other); + FUID& operator= (FUID&& other); +#endif + + + /** Generates a new Unique Identifier (UID). + Will return true for success. If the return value is false, either no + UID is generated or the UID is not guaranteed to be unique worldwide. */ + bool generate (); + + /** Checks if the UID data is valid. + The default constructor initializes the memory with zeros. */ + bool isValid () const; + + FUID& operator = (const FUID& f); + FUID& operator = (FIDString uid); + FUID& operator = (TUID uid); + + bool operator == (const FUID& f) const { return ::Steinberg::FUnknownPrivate::iidEqual (data, f.data); } + bool operator == (FIDString uid) const { return ::Steinberg::FUnknownPrivate::iidEqual (data, uid); } + bool operator == (TUID uid) const { return ::Steinberg::FUnknownPrivate::iidEqual (data, uid); } + + bool operator < (const FUID& f) const { return memcmp (data, f.data, sizeof (TUID)) < 0; } + bool operator < (FIDString uid) const { return memcmp (data, uid, sizeof (TUID)) < 0; } + bool operator < (TUID uid) const { return memcmp (data, uid, sizeof (TUID)) < 0; } + + bool operator != (const FUID& f) const { return !::Steinberg::FUnknownPrivate::iidEqual (data, f.data); } + bool operator != (FIDString uid) const { return !::Steinberg::FUnknownPrivate::iidEqual (data, uid); } + bool operator != (TUID uid) const { return !::Steinberg::FUnknownPrivate::iidEqual (data, uid); } + + operator FIDString () const { return data; } + operator char* () { return data; } + + uint32 getLong1 () const; + uint32 getLong2 () const; + uint32 getLong3 () const; + uint32 getLong4 () const; + + void from4Int (uint32 d1, uint32 d2, uint32 d3, uint32 d4); + void to4Int (uint32& d1, uint32& d2, uint32& d3, uint32& d4) const; + + typedef char8 String [64]; + + /** Converts UID to a string. + The string will be 32 characters long, representing the hexadecimal values + of each data byte (e.g. "9127BE30160E4BB69966670AA6087880"). */ + void toString (char8* string) const; + + /** Sets the UID data from a string. + The string has to be 32 characters long, where each character-pair is + the ASCII-encoded hexadecimal value of the corresponding data byte. */ + bool fromString (const char8* string); + + /** Converts UID to a string in Microsoft® OLE format. + (e.g. "{c200e360-38c5-11ce-ae62-08002b2b79ef}") */ + void toRegistryString (char8* string) const; + + /** Sets the UID data from a string in Microsoft® OLE format. */ + bool fromRegistryString (const char8* string); + + enum UIDPrintStyle + { + kINLINE_UID, ///< "INLINE_UID (0x00000000, 0x00000000, 0x00000000, 0x00000000)" + kDECLARE_UID, ///< "DECLARE_UID (0x00000000, 0x00000000, 0x00000000, 0x00000000)" + kFUID, ///< "FUID (0x00000000, 0x00000000, 0x00000000, 0x00000000)" + kCLASS_UID ///< "DECLARE_CLASS_IID (Interface, 0x00000000, 0x00000000, 0x00000000, 0x00000000)" + }; + /** Prints the UID to a string (or debug output if string is NULL). + \param string is the output string if not NULL. + \param style can be chosen from the FUID::UIDPrintStyle enumeration. */ + void print (char8* string = 0, int32 style = kINLINE_UID) const; + + void toTUID (TUID result) const; + + inline const TUID& toTUID () const + { + return data; + } + +//------------------------------------------------------------------------ +protected: + TUID data; +}; + +//------------------------------------------------------------------------ +inline FUID::FUID (const TUID uid) +{ + memset (data, 0, sizeof (TUID)); + if (uid) + memcpy (data, uid, sizeof (TUID)); +} + +//------------------------------------------------------------------------ +// FUnknown +//------------------------------------------------------------------------ +/** The basic interface of all interfaces. +\ingroup pluginBase + +- The FUnknown::queryInterface method is used to retrieve pointers to other + interfaces of the object. +- FUnknown::addRef and FUnknown::release manage the lifetime of the object. + If no more references exist, the object is destroyed in memory. + +Interfaces are identified by 16 byte Globally Unique Identifiers. +The SDK provides a class called FUID for this purpose. + +\ref howtoClass */ +//------------------------------------------------------------------------ +class FUnknown +{ +public: +//------------------------------------------------------------------------ + /** Query for a pointer to the specified interface. + Returns kResultOk on success or kNoInterface if the object does not implement the interface. + The object has to call addRef when returning an interface. + \param _iid : (in) 16 Byte interface identifier (-> FUID) + \param obj : (out) On return, *obj points to the requested interface */ + virtual tresult PLUGIN_API queryInterface (const TUID _iid, void** obj) = 0; + + /** Adds a reference and return the new reference count. + \par Remarks: + The initial reference count after creating an object is 1. */ + virtual uint32 PLUGIN_API addRef () = 0; + + /** Releases a reference and return the new reference count. + If the reference count reaches zero, the object will be destroyed in memory. */ + virtual uint32 PLUGIN_API release () = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +//------------------------------------------------------------------------ +}; + +DECLARE_CLASS_IID (FUnknown, 0x00000000, 0x00000000, 0xC0000000, 0x00000046) + +//------------------------------------------------------------------------ +// FUnknownPtr +//------------------------------------------------------------------------ +/** FUnknownPtr - automatic interface conversion and smart pointer in one. + This template class can be used for interface conversion like this: + \code + IPtr path = owned (FHostCreate (IPath, hostClasses)); + FUnknownPtr path2 (path); // does a query interface for IPath2 + if (path2) + ... + \endcode +*/ +//------------------------------------------------------------------------ +template +class FUnknownPtr : public IPtr +{ +public: +//------------------------------------------------------------------------ + inline FUnknownPtr (FUnknown* unknown); // query interface + inline FUnknownPtr (const FUnknownPtr& p) : IPtr (p) {} + inline FUnknownPtr () {} + + inline FUnknownPtr& operator=(const FUnknownPtr& p) {IPtr::operator=(p); return *this;} + inline I* operator=(FUnknown* unknown); + inline I* getInterface () { return this->ptr; } +}; + +//------------------------------------------------------------------------ +template +inline FUnknownPtr::FUnknownPtr (FUnknown* unknown) +{ + if (unknown && unknown->queryInterface (I::iid, (void**)&this->ptr) != kResultOk) + this->ptr = 0; +} + +//------------------------------------------------------------------------ +template +inline I* FUnknownPtr::operator=(FUnknown* unknown) +{ + I* newPtr = 0; + if (unknown && unknown->queryInterface (I::iid, (void**)&newPtr) == kResultOk) + { + OPtr rel (newPtr); + return IPtr::operator=(newPtr); + } + + return IPtr::operator=(0); +} + + +//------------------------------------------------------------------------ +// FReleaser (obsolete) +//------------------------------------------------------------------------ +/** Release an interface using automatic object (obsolete). +This class is obsolete and is only kept for compatibility. +The replacement for FReleaser is OPtr. + +Usage example with FReleaser: + \code + void someFunction () + { + IPath* path = pathCreateMethod (); + FReleaser releaser (path); + .... do something with path... + .... path not used anymore, releaser will destroy it when leaving function scope + } + \endcode +Usage example with OPtr: + \code + void someFunction () + { + OPtr path = pathCreateMethod (); + .... do something with path... + .... path not used anymore, OPtr will destroy it when leaving function scope + } + \endcode +*/ +//------------------------------------------------------------------------ +struct FReleaser +{ + FReleaser (FUnknown* u): u (u) {} + ~FReleaser () { if (u) u->release (); } + + FUnknown* u; +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg \ No newline at end of file diff --git a/VST3_SDK/pluginterfaces/base/futils.h b/VST3_SDK/pluginterfaces/base/futils.h new file mode 100644 index 0000000000..a3643fff26 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/futils.h @@ -0,0 +1,92 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/futils.h +// Created by : Steinberg, 01/2004 +// Description : Basic utilities +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/ftypes.h" + +namespace Steinberg { +//---------------------------------------------------------------------------- +// min/max/etc. template functions +template +inline const T& Min (const T& a, const T& b) +{ + return b < a ? b : a; +} + +template +inline const T& Max (const T& a, const T& b) +{ + return a < b ? b : a; +} + +template +inline T Abs (const T& value) +{ + return (value >= (T)0) ? value : -value; +} + +template +inline T Sign (const T& value) +{ + return (value == (T)0) ? 0 : ((value >= (T)0) ? 1 : -1); +} + +template +inline T Bound (T minval, T maxval, T x) +{ + if (x < minval) + return minval; + else if (x > maxval) + return maxval; + return x; +} + +template +void Swap (T& t1, T& t2) +{ + T tmp = t1; + t1 = t2; + t2 = tmp; +} + +template +bool IsApproximateEqual (T t1, T t2, T epsilon) +{ + if (t1 == t2) + return true; + T diff = t1 - t2; + if (diff < 0.0) + diff = -diff; + if (diff < epsilon) + return true; + return false; +} + +template +inline T ToNormalized (const T& value, const int32 numSteps) +{ + return value / T (numSteps); +} + +template +inline int32 FromNormalized (const T& norm, const int32 numSteps) +{ + return Min (numSteps, int32 (norm * (numSteps + 1))); +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/fvariant.h b/VST3_SDK/pluginterfaces/base/fvariant.h new file mode 100644 index 0000000000..99513461c7 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/fvariant.h @@ -0,0 +1,206 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/fvariant.h +// Created by : Steinberg, 01/2004 +// Description : Basic Interface +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/fstrdefs.h" + +//------------------------------------------------------------------------ +namespace Steinberg { + +class FUnknown; + +//------------------------------------------------------------------------ +// FVariant struct declaration +//------------------------------------------------------------------------ +/** A Value of variable type. + \ingroup pluginBase + */ +class FVariant +{ +//------------------------------------------------------------------------ +public: + enum + { + kEmpty = 0, + kInteger = 1 << 0, + kFloat = 1 << 1, + kString8 = 1 << 2, + kObject = 1 << 3, + kOwner = 1 << 4, + kString16 = 1 << 5 + }; + +//------------------------------------------------------------------------ + // ctors + inline FVariant () { memset (this, 0, sizeof (FVariant)); } + inline FVariant (const FVariant& variant); + + inline FVariant (int64 v) : type (kInteger), intValue (v) {} + inline FVariant (double v) : type (kFloat), floatValue (v) {} + inline FVariant (const char8* str) : type (kString8), string8 (str) {} + inline FVariant (const char16* str) : type (kString16), string16 (str) {} + inline FVariant (FUnknown* obj, bool owner = false) : type (kObject), object (obj) + { + setOwner (owner); + } + inline ~FVariant () { empty (); } + +//------------------------------------------------------------------------ + inline FVariant& operator= (const FVariant& variant); + + inline void setInt (int64 v) + { + empty (); + type = kInteger; + intValue = v; + } + inline void setFloat (double v) + { + empty (); + type = kFloat; + floatValue = v; + } + inline void setString8 (const char8* v) + { + empty (); + type = kString8; + string8 = v; + } + inline void setString16 (const char16* v) + { + empty (); + type = kString16; + string16 = v; + } + + inline void setObject (FUnknown* obj) + { + empty (); + type = kObject; + object = obj; + } + + inline int64 getInt () const { return (type & kInteger) ? intValue : 0; } + inline double getFloat () const { return (type & kFloat) ? floatValue : 0.; } + inline double getNumber () const + { + return (type & kInteger) ? static_cast (intValue) : (type & kFloat) ? floatValue : + 0.; + } + inline const char8* getString8 () const { return (type & kString8) ? string8 : 0; } + inline const char16* getString16 () const { return (type & kString16) ? string16 : 0; } + + inline FUnknown* getObject () const { return (type & kObject) ? object : 0; } + + inline uint16 getType () const { return static_cast (type & ~(kOwner)); } + inline bool isEmpty () const { return getType () == kEmpty; } + inline bool isOwner () const { return (type & kOwner) != 0; } + inline bool isString () const { return (type & (kString8 | kString16)) != 0; } + inline void setOwner (bool state) + { + if (state) + type |= kOwner; + else + type &= ~kOwner; + } + + void empty (); +//------------------------------------------------------------------------ + uint16 type; + union + { + int64 intValue; + double floatValue; + const char8* string8; + const char16* string16; + FUnknown* object; + }; +}; + +//------------------------------------------------------------------------ +inline bool operator== (const FVariant& v1, const FVariant& v2) +{ +#if PLATFORM_64 + return v1.type == v2.type && v1.intValue == v2.intValue; +#else + if (v1.type != v2.type) + return false; + if (v1.type & (FVariant::kString8 | FVariant::kString16 | FVariant::kObject)) + return v1.string8 == v2.string8; // pointer type comparisons + return v1.intValue == v2.intValue; // intValue & double comparison + +#endif +} + +//------------------------------------------------------------------------ +inline bool operator!= (const FVariant& v1, const FVariant& v2) { return !(v1 == v2); } + +//------------------------------------------------------------------------ +inline FVariant::FVariant (const FVariant& variant) : type (kEmpty) { *this = variant; } + +//------------------------------------------------------------------------ +inline void FVariant::empty () +{ + if (type & kOwner) + { + if ((type & kString8) && string8) + delete[] string8; + else if ((type & kString16) && string16) + delete[] string16; + + else if ((type & kObject) && object) + object->release (); + } + memset (this, 0, sizeof (FVariant)); +} + +//------------------------------------------------------------------------ +inline FVariant& FVariant::operator= (const FVariant& variant) +{ + empty (); + + type = variant.type; + + if ((type & kString8) && variant.string8) + { + string8 = new char8[strlen (variant.string8) + 1]; + strcpy (const_cast (string8), variant.string8); + type |= kOwner; + } + else if ((type & kString16) && variant.string16) + { + int32 len = strlen16 (variant.string16); + string16 = new char16[len + 1]; + char16* tmp = const_cast (string16); + memcpy (tmp, variant.string16, len * sizeof (char16)); + tmp[len] = 0; + type |= kOwner; + } + else if ((type & kObject) && variant.object) + { + object = variant.object; + object->addRef (); + type |= kOwner; + } + else + intValue = variant.intValue; // copy memory + + return *this; +} + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/geoconstants.h b/VST3_SDK/pluginterfaces/base/geoconstants.h new file mode 100644 index 0000000000..61e9fdd86a --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/geoconstants.h @@ -0,0 +1,96 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/geoconstants.h +// Created by : Steinberg, 11/2014 +// Description : Defines orientations and directions as also used by fpoint.h and frect.h +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +//------------------------------------------------------------------------ +namespace Steinberg { + +//------------------------------------------------------------------------ +enum Direction +{ + kNorth, + kNorthEast, + kEast, + kSouthEast, + kSouth, + kSouthWest, + kWest, + kNorthWest, + kNoDirection, //same position or center point of a geometry + + kNumberOfDirections +}; + +//------------------------------------------------------------------------ +enum Orientation +{ + kHorizontal, + kVertical, + kNumberOfOrientations +}; + +//------------------------------------------------------------------------ +namespace GeoConstants { + +//------------------------------------------------------------------------ +inline Direction toOpposite (Direction dir) +{ + switch (dir) + { + case kNorth : return kSouth; + case kNorthEast : return kSouthWest; + case kEast : return kWest; + case kSouthEast : return kNorthWest; + case kSouth : return kNorth; + case kSouthWest : return kNorthEast; + case kWest : return kEast; + case kNorthWest : return kSouthEast; + case kNoDirection : return kNoDirection; + default: + return kNumberOfDirections; + } +} + +//------------------------------------------------------------------------ +inline Orientation toOrientation (Direction dir) +{ + switch (dir) + { + case kNorth : return kVertical; + case kEast : return kHorizontal; + case kSouth : return kVertical; + case kWest : return kHorizontal; + default: + return kNumberOfOrientations; + } +} + +//------------------------------------------------------------------------ +inline Orientation toOrthogonalOrientation (Orientation dir) +{ + switch (dir) + { + case kVertical : return kHorizontal; + case kHorizontal : return kVertical; + default: + return kNumberOfOrientations; + } +} + +//------------------------------------------------------------------------ +} // namespace GeoConstants +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/ibstream.h b/VST3_SDK/pluginterfaces/base/ibstream.h new file mode 100644 index 0000000000..6219255014 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/ibstream.h @@ -0,0 +1,89 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/ibstream.h +// Created by : Steinberg, 01/2004 +// Description : Interface for reading/writing streams +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "funknown.h" + +namespace Steinberg { + +//------------------------------------------------------------------------ +/** Base class for streams. +\ingroup pluginBase +- read/write binary data from/to stream +- get/set stream read-write position (read and write position is the same) +*/ +//------------------------------------------------------------------------ + +class IBStream: public FUnknown +{ +public: + enum IStreamSeekMode + { + kIBSeekSet = 0, ///< set absolute seek position + kIBSeekCur, ///< set seek position relative to current position + kIBSeekEnd ///< set seek position relative to stream end + }; + +//------------------------------------------------------------------------ + /** Reads binary data from stream. + \param buffer : destination buffer + \param numBytes : amount of bytes to be read + \param numBytesRead : result - how many bytes have been read from stream (set to 0 if this is of no interest) */ + virtual tresult PLUGIN_API read (void* buffer, int32 numBytes, int32* numBytesRead = 0) = 0; + + /** Writes binary data to stream. + \param buffer : source buffer + \param numBytes : amount of bytes to write + \param numBytesWritten : result - how many bytes have been written to stream (set to 0 if this is of no interest) */ + virtual tresult PLUGIN_API write (void* buffer, int32 numBytes, int32* numBytesWritten = 0) = 0; + + /** Sets stream read-write position. + \param pos : new stream position (dependent on mode) + \param mode : value of enum IStreamSeekMode + \param result : new seek position (set to 0 if this is of no interest) */ + virtual tresult PLUGIN_API seek (int64 pos, int32 mode, int64* result = 0) = 0; + + /** Gets current stream read-write position. + \param pos : is assigned the current position if function succeeds */ + virtual tresult PLUGIN_API tell (int64* pos) = 0; +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IBStream, 0xC3BF6EA2, 0x30994752, 0x9B6BF990, 0x1EE33E9B) + +//------------------------------------------------------------------------ +/** Stream with a size. +\ingroup pluginBase +[extends IBStream] when stream type supports it (like file and memory stream) */ +//------------------------------------------------------------------------ +class ISizeableStream: public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** Return the stream size */ + virtual tresult PLUGIN_API getStreamSize (int64& size) = 0; + /** Set the steam size. File streams can only be resized if they are write enabled. */ + virtual tresult PLUGIN_API setStreamSize (int64 size) = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +}; +DECLARE_CLASS_IID (ISizeableStream, 0x04F9549E, 0xE02F4E6E, 0x87E86A87, 0x47F4E17F) + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/icloneable.h b/VST3_SDK/pluginterfaces/base/icloneable.h new file mode 100644 index 0000000000..98b62821e3 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/icloneable.h @@ -0,0 +1,42 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/icloneable.h +// Created by : Steinberg, 11/2007 +// Description : Interface for object copies +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "funknown.h" + +namespace Steinberg { + +//------------------------------------------------------------------------ +/** Interface allowing an object to be copied. +[plug & host imp] \n +[released: N4.12] \n +*/ +//------------------------------------------------------------------------ +class ICloneable : public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** Create exact copy of the object */ + virtual FUnknown* PLUGIN_API clone () = 0; +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (ICloneable, 0xD45406B9, 0x3A2D4443, 0x9DAD9BA9, 0x85A1454B) + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/ierrorcontext.h b/VST3_SDK/pluginterfaces/base/ierrorcontext.h new file mode 100644 index 0000000000..57ec4ca0b5 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/ierrorcontext.h @@ -0,0 +1,47 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/ierrorcontext.h +// Created by : Steinberg, 02/2008 +// Description : Error Context Interface +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/funknown.h" + +namespace Steinberg { + +class IString; + +//------------------------------------------------------------------------ +/** Interface for error handling. +[plug imp] \n +[released: Sequel 2] */ +//------------------------------------------------------------------------ +class IErrorContext : public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** Tells the plug-in to not show any UI elements on errors. */ + virtual void PLUGIN_API disableErrorUI (bool state) = 0; + /** If an error happens and disableErrorUI was not set this should return kResultTrue if the plug-in already showed a message to the user what happened. */ + virtual tresult PLUGIN_API errorMessageShown () = 0; + /** Fill message with error string. The host may show this to the user. */ + virtual tresult PLUGIN_API getErrorMessage (IString* message) = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +}; +DECLARE_CLASS_IID (IErrorContext, 0x12BCD07B, 0x7C694336, 0xB7DA77C3, 0x444A0CD0) + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/ipersistent.h b/VST3_SDK/pluginterfaces/base/ipersistent.h new file mode 100644 index 0000000000..5da3cc7802 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/ipersistent.h @@ -0,0 +1,161 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/ipersistent.h +// Created by : Steinberg, 09/2004 +// Description : Plug-In Storage Interfaces +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/funknown.h" + +namespace Steinberg { + +class FVariant; +class IAttributes; +//------------------------------------------------------------------------ +/** Persistent Object Interface. +[plug imp] \n +This interface is used to store/restore attributes of an object. +An IPlugController can implement this interface to handle presets. +The gui-xml for a preset control looks like this: +\code + .... + + .... + +\endcode +The tag data="Preset" tells the host to create a preset controller that handles the +3 values named "preset control", "store preset", and "remove preset". +*/ +//------------------------------------------------------------------------ +class IPersistent: public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** The class ID must be a 16 bytes unique id that is used to create the object. + This ID is also used to identify the preset list when used with presets. */ + virtual tresult PLUGIN_API getClassID (char8* uid) = 0; + /** Store all members/data in the passed IAttributes. */ + virtual tresult PLUGIN_API saveAttributes (IAttributes* ) = 0; + /** Restore all members/data from the passed IAttributes. */ + virtual tresult PLUGIN_API loadAttributes (IAttributes* ) = 0; +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IPersistent, 0xBA1A4637, 0x3C9F46D0, 0xA65DBA0E, 0xB85DA829) + + +typedef FIDString IAttrID; +//------------------------------------------------------------------------ +/** Object Data Archive Interface. +[host imp] \n +- store data/objects/binary/subattributes in the archive +- read stored data from the archive + +All data stored to the archive are identified by a string (IAttrID), which must be unique on each +IAttribute level. + +The basic set/get methods make use of the FVariant class defined in 'funknown.h'. +For a more convenient usage of this interface, you should use the functions defined +in namespace PAttributes (public.sdk/source/common/pattributes.h+cpp) !! + +\ingroup frameworkHostClasses +*/ +//------------------------------------------------------------------------ +class IAttributes: public FUnknown +{ +public: +//------------------------------------------------------------------------ + /*! \name Methods to write attributes + ******************************************************************************************************** */ + //@{ + /** Store any data in the archive. It is even possible to store sub-attributes by creating + a new IAttributes instance via the IHostClasses interface and pass it to the parent in the + FVariant. In this case the archive must take the ownership of the newly created object, which + is true for all objects that have been created only for storing. You tell the archive to take + ownership by adding the FVariant::kOwner flag to the FVariant::type member (data.type |= FVariant::kOwner). + When using the PAttributes functions, this is done through a function parameter.*/ + virtual tresult PLUGIN_API set (IAttrID attrID, const FVariant& data) = 0; + + /** Store a list of data in the archive. Please note that the type of data is not mixable! So + you can only store a list of integers or a list of doubles/strings/etc. You can also store a list + of subattributes or other objects that implement the IPersistent interface.*/ + virtual tresult PLUGIN_API queue (IAttrID listID, const FVariant& data) = 0; + + /** Store binary data in the archive. Parameter 'copyBytes' specifies if the passed data should be copied. + The archive cannot take the ownership of binary data. Either it just references a buffer in order + to write it to a file (copyBytes = false) or it copies the data to its own buffers (copyBytes = true). + When binary data should be stored in the default pool for example, you must always copy it!*/ + virtual tresult PLUGIN_API setBinaryData (IAttrID attrID, void* data, uint32 bytes, bool copyBytes) = 0; + //@} + + /*! \name Methods to read attributes + ******************************************************************************************************** */ + //@{ + /** Get data previously stored to the archive. */ + virtual tresult PLUGIN_API get (IAttrID attrID, FVariant& data) = 0; + + /** Get list of data previously stored to the archive. As long as there are queue members the method + will return kResultTrue. When the queue is empty, the methods returns kResultFalse. All lists except from + object lists can be reset which means that the items can be read once again. \see IAttributes::resetQueue */ + virtual tresult PLUGIN_API unqueue (IAttrID listID, FVariant& data) = 0; + + /** Get the amount of items in a queue. */ + virtual int32 PLUGIN_API getQueueItemCount (IAttrID) = 0; + + /** Reset a queue. If you need to restart reading a queue, you have to reset it. You can reset a queue at any time.*/ + virtual tresult PLUGIN_API resetQueue (IAttrID attrID) = 0; + + /** Reset all queues in the archive.*/ + virtual tresult PLUGIN_API resetAllQueues () = 0; + + /** Read binary data from the archive. The data is copied into the passed buffer. The size of that buffer + must fit the size of data stored in the archive which can be queried via IAttributes::getBinaryDataSize */ + virtual tresult PLUGIN_API getBinaryData (IAttrID attrID, void* data, uint32 bytes) = 0; + /** Get the size in bytes of binary data in the archive. */ + virtual uint32 PLUGIN_API getBinaryDataSize (IAttrID attrID) = 0; + //@} + +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IAttributes, 0xFA1E32F9, 0xCA6D46F5, 0xA982F956, 0xB1191B58) + +//------------------------------------------------------------------------ +/** Extended access to Attributes; supports Attribute retrieval via iteration. +[host imp] \n +[released] C7/N6 \n +\ingroup frameworkHostClasses +*/ +//------------------------------------------------------------------------ +class IAttributes2 : public IAttributes +{ +public: + /** Returns the number of existing attributes. */ + virtual int32 PLUGIN_API countAttributes () const = 0; + /** Returns the attribute's ID for the given index. */ + virtual IAttrID PLUGIN_API getAttributeID (int32 index) const = 0; +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IAttributes2, 0x1382126A, 0xFECA4871, 0x97D52A45, 0xB042AE99) + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/ipluginbase.h b/VST3_SDK/pluginterfaces/base/ipluginbase.h new file mode 100644 index 0000000000..78c9c38d72 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/ipluginbase.h @@ -0,0 +1,398 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/ipluginbase.h +// Created by : Steinberg, 01/2004 +// Description : Basic Plug-in Interfaces +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "funknown.h" +#include "fstrdefs.h" + +namespace Steinberg { + +//------------------------------------------------------------------------ +/** Basic interface to a Plug-in component. +\ingroup pluginBase +- [plug imp] +- initialize/terminate the Plug-in component + +The host uses this interface to initialize and to terminate the Plug-in component. +The context that is passed to the initialize method contains any interface to the +host that the Plug-in will need to work. These interfaces can vary from category to category. +A list of supported host context interfaces should be included in the documentation +of a specific category. */ +//------------------------------------------------------------------------ +class IPluginBase: public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** The host passes a number of interfaces as context to initialize the Plug-in class. + @note Extensive memory allocations etc. should be performed in this method rather than in the class' constructor! + If the method does NOT return kResultOk, the object is released immediately. In this case terminate is not called! */ + virtual tresult PLUGIN_API initialize (FUnknown* context) = 0; + + /** This function is called before the Plug-in is unloaded and can be used for + cleanups. You have to release all references to any host application interfaces. */ + virtual tresult PLUGIN_API terminate () = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IPluginBase, 0x22888DDB, 0x156E45AE, 0x8358B348, 0x08190625) + + +//------------------------------------------------------------------------ +/** Basic Information about the class factory of the Plug-in. +\ingroup pluginBase +*/ +//------------------------------------------------------------------------ +struct PFactoryInfo +{ +//------------------------------------------------------------------------ + enum FactoryFlags + { + kNoFlags = 0, ///< Nothing + kClassesDiscardable = 1 << 0, ///< The number of exported classes can change each time the Module is loaded. If this flag is set, the host does not cache class information. This leads to a longer startup time because the host always has to load the Module to get the current class information. + kLicenseCheck = 1 << 1, ///< Class IDs of components are interpreted as Syncrosoft-License (LICENCE_UID). Loaded in a Steinberg host, the module will not be loaded when the license is not valid + kComponentNonDiscardable = 1 << 3, ///< Component won't be unloaded until process exit + kUnicode = 1 << 4 ///< Components have entirely unicode encoded strings. (True for VST 3 Plug-ins so far) + }; + + enum + { + kURLSize = 256, + kEmailSize = 128, + kNameSize = 64 + }; + +//------------------------------------------------------------------------ + char8 vendor[kNameSize]; ///< e.g. "Steinberg Media Technologies" + char8 url[kURLSize]; ///< e.g. "http://www.steinberg.de" + char8 email[kEmailSize]; ///< e.g. "info@steinberg.de" + int32 flags; ///< (see above) +//------------------------------------------------------------------------ + PFactoryInfo (const char8* _vendor, const char8* _url, const char8* _email, int32 _flags) + { + strncpy8 (vendor, _vendor, kNameSize); + strncpy8 (url, _url, kURLSize); + strncpy8 (email, _email, kEmailSize); + flags = _flags; +#ifdef UNICODE + flags |= kUnicode; +#endif + } + PFactoryInfo () { memset (this, 0, sizeof (PFactoryInfo)); } +}; + +//------------------------------------------------------------------------ +/** Basic Information about a class provided by the Plug-in. +\ingroup pluginBase +*/ +//------------------------------------------------------------------------ +struct PClassInfo +{ +//------------------------------------------------------------------------ + enum ClassCardinality + { + kManyInstances = 0x7FFFFFFF + }; + + enum + { + kCategorySize = 32, + kNameSize = 64 + }; +//------------------------------------------------------------------------ + TUID cid; ///< Class ID 16 Byte class GUID + int32 cardinality; ///< cardinality of the class, set to kManyInstances (see \ref ClassCardinality) + char8 category[kCategorySize]; ///< class category, host uses this to categorize interfaces + char8 name[kNameSize]; ///< class name, visible to the user +//------------------------------------------------------------------------ + + PClassInfo (TUID _cid, int32 _cardinality, const char8* _category, const char8* _name) + { + memset (this, 0, sizeof (PClassInfo)); + memcpy (cid, _cid, sizeof (TUID)); + if (_category) + strncpy8 (category, _category, kCategorySize); + if (_name) + strncpy8 (name, _name, kNameSize); + cardinality = _cardinality; + } + PClassInfo () { memset (this, 0, sizeof (PClassInfo)); } +}; + + +//------------------------------------------------------------------------ +// IPluginFactory interface declaration +//------------------------------------------------------------------------ +/** Class factory that any Plug-in defines for creating class instances. +\ingroup pluginBase +- [plug imp] + +From the host's point of view a Plug-in module is a factory which can create +a certain kind of object(s). The interface IPluginFactory provides methods +to get information about the classes exported by the Plug-in and a +mechanism to create instances of these classes (that usually define the IPluginBase interface). + + An implementation is provided in public.sdk/source/common/pluginfactory.cpp +\see GetPluginFactory +*/ +//------------------------------------------------------------------------ +class IPluginFactory : public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** Fill a PFactoryInfo structure with information about the Plug-in vendor. */ + virtual tresult PLUGIN_API getFactoryInfo (PFactoryInfo* info) = 0; + + /** Returns the number of exported classes by this factory. + If you are using the CPluginFactory implementation provided by the SDK, it returns the number of classes you registered with CPluginFactory::registerClass. */ + virtual int32 PLUGIN_API countClasses () = 0; + + /** Fill a PClassInfo structure with information about the class at the specified index. */ + virtual tresult PLUGIN_API getClassInfo (int32 index, PClassInfo* info) = 0; + + /** Create a new class instance. */ + virtual tresult PLUGIN_API createInstance (FIDString cid, FIDString _iid, void** obj) = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IPluginFactory, 0x7A4D811C, 0x52114A1F, 0xAED9D2EE, 0x0B43BF9F) + + +//------------------------------------------------------------------------ +/** Version 2 of Basic Information about a class provided by the Plug-in. +\ingroup pluginBase +*/ +//------------------------------------------------------------------------ +struct PClassInfo2 +{ +//------------------------------------------------------------------------ + TUID cid; ///< Class ID 16 Byte class GUID + int32 cardinality; ///< cardinality of the class, set to kManyInstances (see \ref ClassCardinality) + char8 category[PClassInfo::kCategorySize]; ///< class category, host uses this to categorize interfaces + char8 name[PClassInfo::kNameSize]; ///< class name, visible to the user + + enum { + kVendorSize = 64, + kVersionSize = 64, + kSubCategoriesSize = 128 + }; + + uint32 classFlags; ///< flags used for a specific category, must be defined where category is defined + char8 subCategories[kSubCategoriesSize]; ///< module specific subcategories, can be more than one, logically added by the \c OR operator + char8 vendor[kVendorSize]; ///< overwrite vendor information from factory info + char8 version[kVersionSize]; ///< Version string (e.g. "1.0.0.512" with Major.Minor.Subversion.Build) + char8 sdkVersion[kVersionSize]; ///< SDK version used to build this class (e.g. "VST 3.0") + +//------------------------------------------------------------------------ + + PClassInfo2 (const TUID _cid, int32 _cardinality, const char8* _category, const char8* _name, + int32 _classFlags, const char8* _subCategories, const char8* _vendor, const char8* _version, + const char8* _sdkVersion) + { + memset (this, 0, sizeof (PClassInfo2)); + memcpy (cid, _cid, sizeof (TUID)); + cardinality = _cardinality; + if (_category) + strncpy8 (category, _category, PClassInfo::kCategorySize); + if (_name) + strncpy8 (name, _name, PClassInfo::kNameSize); + classFlags = _classFlags; + if (_subCategories) + strncpy8 (subCategories, _subCategories, kSubCategoriesSize); + if (_vendor) + strncpy8 (vendor, _vendor, kVendorSize); + if (_version) + strncpy8 (version, _version, kVersionSize); + if (_sdkVersion) + strncpy8 (sdkVersion, _sdkVersion, kVersionSize); + } + PClassInfo2 () { memset (this, 0, sizeof (PClassInfo2)); } +}; + +//------------------------------------------------------------------------ +// IPluginFactory2 interface declaration +//------------------------------------------------------------------------ +/** Version 2 of class factory supporting PClassInfo2. +\ingroup pluginBase +\copydoc IPluginFactory +*/ +//------------------------------------------------------------------------ +class IPluginFactory2 : public IPluginFactory +{ +public: +//------------------------------------------------------------------------ + /** Returns the class info (version 2) for a given index. */ + virtual tresult PLUGIN_API getClassInfo2 (int32 index, PClassInfo2* info) = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +}; +DECLARE_CLASS_IID (IPluginFactory2, 0x0007B650, 0xF24B4C0B, 0xA464EDB9, 0xF00B2ABB) + + +//------------------------------------------------------------------------ +/** Unicode Version of Basic Information about a class provided by the Plug-in */ +//------------------------------------------------------------------------ +struct PClassInfoW +{ +//------------------------------------------------------------------------ + TUID cid; ///< see \ref PClassInfo + int32 cardinality; ///< see \ref PClassInfo + char8 category[PClassInfo::kCategorySize]; ///< see \ref PClassInfo + char16 name[PClassInfo::kNameSize]; ///< see \ref PClassInfo + + enum { + kVendorSize = 64, + kVersionSize = 64, + kSubCategoriesSize = 128 + }; + + uint32 classFlags; ///< flags used for a specific category, must be defined where category is defined + char8 subCategories[kSubCategoriesSize];///< module specific subcategories, can be more than one, logically added by the \c OR operator + char16 vendor[kVendorSize]; ///< overwrite vendor information from factory info + char16 version[kVersionSize]; ///< Version string (e.g. "1.0.0.512" with Major.Minor.Subversion.Build) + char16 sdkVersion[kVersionSize]; ///< SDK version used to build this class (e.g. "VST 3.0") + +//------------------------------------------------------------------------ + PClassInfoW (const TUID _cid, int32 _cardinality, const char8* _category, const char16* _name, + int32 _classFlags, const char8* _subCategories, const char16* _vendor, const char16* _version, + const char16* _sdkVersion) + { + memset (this, 0, sizeof (PClassInfoW)); + memcpy (cid, _cid, sizeof (TUID)); + cardinality = _cardinality; + if (_category) + strncpy8 (category, _category, PClassInfo::kCategorySize); + if (_name) + strncpy16 (name, _name, PClassInfo::kNameSize); + classFlags = _classFlags; + if (_subCategories) + strncpy8 (subCategories, _subCategories, kSubCategoriesSize); + if (_vendor) + strncpy16 (vendor, _vendor, kVendorSize); + if (_version) + strncpy16 (version, _version, kVersionSize); + if (_sdkVersion) + strncpy16 (sdkVersion, _sdkVersion, kVersionSize); + } + PClassInfoW () { memset (this, 0, sizeof (PClassInfoW)); } + + void fromAscii (const PClassInfo2& ci2) + { + memcpy (cid, ci2.cid, sizeof (TUID)); + cardinality = ci2.cardinality; + strncpy8 (category, ci2.category, PClassInfo::kCategorySize); + str8ToStr16 (name, ci2.name, PClassInfo::kNameSize); + classFlags = ci2.classFlags; + strncpy8 (subCategories, ci2.subCategories, kSubCategoriesSize); + + str8ToStr16 (vendor, ci2.vendor, kVendorSize); + str8ToStr16 (version, ci2.version, kVersionSize); + str8ToStr16 (sdkVersion, ci2.sdkVersion, kVersionSize); + } +}; + + +//------------------------------------------------------------------------ +// IPluginFactory3 interface declaration +//------------------------------------------------------------------------ +/** Version 3 of class factory supporting PClassInfoW. +\ingroup pluginBase +\copydoc IPluginFactory +*/ +//------------------------------------------------------------------------ +class IPluginFactory3 : public IPluginFactory2 +{ +public: +//------------------------------------------------------------------------ + /** Returns the unicode class info for a given index. */ + virtual tresult PLUGIN_API getClassInfoUnicode (int32 index, PClassInfoW* info) = 0; + + /** Receives information about host*/ + virtual tresult PLUGIN_API setHostContext (FUnknown* context) = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +}; +DECLARE_CLASS_IID (IPluginFactory3, 0x4555A2AB, 0xC1234E57, 0x9B122910, 0x36878931) +//------------------------------------------------------------------------ +} // namespace Steinberg + + +//------------------------------------------------------------------------ +#define LICENCE_UID(l1, l2, l3, l4) \ +{ \ + (int8)((l1 & 0xFF000000) >> 24), (int8)((l1 & 0x00FF0000) >> 16), \ + (int8)((l1 & 0x0000FF00) >> 8), (int8)((l1 & 0x000000FF) ), \ + (int8)((l2 & 0xFF000000) >> 24), (int8)((l2 & 0x00FF0000) >> 16), \ + (int8)((l2 & 0x0000FF00) >> 8), (int8)((l2 & 0x000000FF) ), \ + (int8)((l3 & 0xFF000000) >> 24), (int8)((l3 & 0x00FF0000) >> 16), \ + (int8)((l3 & 0x0000FF00) >> 8), (int8)((l3 & 0x000000FF) ), \ + (int8)((l4 & 0xFF000000) >> 24), (int8)((l4 & 0x00FF0000) >> 16), \ + (int8)((l4 & 0x0000FF00) >> 8), (int8)((l4 & 0x000000FF) ) \ +} + + +//------------------------------------------------------------------------ +// GetPluginFactory +//------------------------------------------------------------------------ +/** Plug-in entry point. +\ingroup pluginBase +Any Plug-in must define and export this function. \n +A typical implementation of GetPluginFactory looks like this + \code + IPluginFactory* PLUGIN_API GetPluginFactory () + { + if (!gPluginFactory) + { + static PFactoryInfo factoryInfo = + { + "My Company Name", + "http://www.mywebpage.com", + "mailto:myemail@address.com", + PFactoryInfo::kNoFlags + }; + + gPluginFactory = new CPluginFactory (factoryInfo); + + static PClassInfo componentClass = + { + INLINE_UID (0x00000000, 0x00000000, 0x00000000, 0x00000000), // replace by a valid uid + 1, + "Service", // category + "Name" + }; + + gPluginFactory->registerClass (&componentClass, MyComponentClass::newInstance); + } + else + gPluginFactory->addRef (); + + return gPluginFactory; + } + \endcode +\see \ref loadPlugin +*/ +//------------------------------------------------------------------------ +extern "C" +{ + Steinberg::IPluginFactory* PLUGIN_API GetPluginFactory (); + typedef Steinberg::IPluginFactory* (PLUGIN_API *GetFactoryProc) (); +} diff --git a/VST3_SDK/pluginterfaces/base/istringresult.h b/VST3_SDK/pluginterfaces/base/istringresult.h new file mode 100644 index 0000000000..90531838cd --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/istringresult.h @@ -0,0 +1,80 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/istringresult.h +// Created by : Steinberg, 01/2005 +// Description : Strings Interface +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/funknown.h" + +namespace Steinberg { + +//------------------------------------------------------------------------ +/** Interface to return an ascii string of variable size. + In order to manage memory allocation and deallocation properly, + this interface is used to transfer a string as result parameter of + a method requires a string of unknown size. +[host imp] or [plug imp] \n +[released: SX 4] */ +//------------------------------------------------------------------------ +class IStringResult : public FUnknown +{ +public: +//------------------------------------------------------------------------ + virtual void PLUGIN_API setText (const char8* text) = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IStringResult, 0x550798BC, 0x872049DB, 0x84920A15, 0x3B50B7A8) + + +//------------------------------------------------------------------------ +/** Interface to a string of variable size and encoding. +[host imp] or [plug imp] \n +[released: ] */ +//------------------------------------------------------------------------ +class IString : public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** Assign ASCII string */ + virtual void PLUGIN_API setText8 (const char8* text) = 0; + /** Assign unicode string */ + virtual void PLUGIN_API setText16 (const char16* text) = 0; + + /** Return ASCII string. If the string is unicode so far, it will be converted. + So you need to be careful, because the conversion can result in data loss. + It is save though to call getText8 if isWideString() returns false */ + virtual const char8* PLUGIN_API getText8 () = 0; + /** Return unicode string. If the string is ASCII so far, it will be converted. */ + virtual const char16* PLUGIN_API getText16 () = 0; + + /** !Do not use this method! Early implementations take the given pointer as + internal string and this will cause problems because 'free' will be used to delete the passed memory. + Later implementations will redirect 'take' to setText8 and setText16 */ + virtual void PLUGIN_API take (void* s, bool isWide) = 0; + + /** Returns true if the string is in unicode format, returns false if the string is ASCII */ + virtual bool PLUGIN_API isWideString () const = 0; + +//------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IString, 0xF99DB7A3, 0x0FC14821, 0x800B0CF9, 0x8E348EDF) + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/iupdatehandler.h b/VST3_SDK/pluginterfaces/base/iupdatehandler.h new file mode 100644 index 0000000000..c4374c468c --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/iupdatehandler.h @@ -0,0 +1,100 @@ +//------------------------------------------------------------------------ +// Project : Steinberg Module Architecture SDK +// +// Category : Basic Host Service Interfaces +// Filename : pluginterfaces/base/iupdatehandler.h +// Created by : Steinberg, 01/2004 +// Description : Update handling +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/funknown.h" + +namespace Steinberg { + +class IDependent; + +//------------------------------------------------------------------------ +/** Host implements dependency handling for plugins. +[host imp] \n +[get this interface from IHostClasses] \n +[released N3.1] \n + +- Install/Remove change notifications +- Trigger updates when an object has changed + +Can be used between host-objects and the Plug-In or +inside the Plug-In to handle internal updates! + +\see IDependent +\ingroup frameworkHostClasses +*/ +//------------------------------------------------------------------------ +class IUpdateHandler: public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** Install update notification for given object. It is essential to + remove all dependencies again using 'removeDependent'! Dependencies + are not removed automatically when the 'object' is released! + \param object : interface to object that sends change notifications + \param dependent : interface through which the update is passed */ + virtual tresult PLUGIN_API addDependent (FUnknown* object, IDependent* dependent) = 0; + + /** Remove a previously installed dependency.*/ + virtual tresult PLUGIN_API removeDependent (FUnknown* object, IDependent* dependent) = 0; + + /** Inform all dependents, that object has changed. + \param object is the object that has changed + \param message is a value of enum IDependent::ChangeMessage, usually IDependent::kChanged - can be + a private message as well (only known to sender and dependent)*/ + virtual tresult PLUGIN_API triggerUpdates (FUnknown* object, int32 message) = 0; + + /** Same as triggerUpdates, but delivered in idle (usefull to collect updates).*/ + virtual tresult PLUGIN_API deferUpdates (FUnknown* object, int32 message) = 0; + static const FUID iid; +}; + +DECLARE_CLASS_IID (IUpdateHandler, 0xF5246D56, 0x86544d60, 0xB026AFB5, 0x7B697B37) + +//------------------------------------------------------------------------ +/** A dependent will get notified about changes of a model. +[plug imp] +- notify changes of a model + +\see IUpdateHandler +\ingroup frameworkHostClasses +*/ +//------------------------------------------------------------------------ +class IDependent: public FUnknown +{ +public: +//------------------------------------------------------------------------ + /** Inform the dependent, that the passed FUnknown has changed. */ + virtual void PLUGIN_API update (FUnknown* changedUnknown, int32 message) = 0; + + enum ChangeMessage + { + kWillChange, + kChanged, + kDestroyed, + kWillDestroy, + + kStdChangeMessageLast = kWillDestroy + }; + //------------------------------------------------------------------------ + static const FUID iid; +}; + +DECLARE_CLASS_IID (IDependent, 0xF52B7AAE, 0xDE72416d, 0x8AF18ACE, 0x9DD7BD5E) + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/keycodes.h b/VST3_SDK/pluginterfaces/base/keycodes.h new file mode 100644 index 0000000000..80cad69c21 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/keycodes.h @@ -0,0 +1,161 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/keycodes.h +// Created by : Steinberg, 01/2004 +// Description : Key Code Definitions +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/ftypes.h" + +namespace Steinberg { +//------------------------------------------------------------------------------ +/** Virtual Key Codes. +OS-independent enumeration of virtual keycodes. +*/ +//------------------------------------------------------------------------------ +enum VirtualKeyCodes +{ + KEY_BACK = 1, + KEY_TAB, + KEY_CLEAR, + KEY_RETURN, + KEY_PAUSE, + KEY_ESCAPE, + KEY_SPACE, + KEY_NEXT, + KEY_END, + KEY_HOME, + + KEY_LEFT, + KEY_UP, + KEY_RIGHT, + KEY_DOWN, + KEY_PAGEUP, + KEY_PAGEDOWN, + + KEY_SELECT, + KEY_PRINT, + KEY_ENTER, + KEY_SNAPSHOT, + KEY_INSERT, + KEY_DELETE, + KEY_HELP, + KEY_NUMPAD0, + KEY_NUMPAD1, + KEY_NUMPAD2, + KEY_NUMPAD3, + KEY_NUMPAD4, + KEY_NUMPAD5, + KEY_NUMPAD6, + KEY_NUMPAD7, + KEY_NUMPAD8, + KEY_NUMPAD9, + KEY_MULTIPLY, + KEY_ADD, + KEY_SEPARATOR, + KEY_SUBTRACT, + KEY_DECIMAL, + KEY_DIVIDE, + KEY_F1, + KEY_F2, + KEY_F3, + KEY_F4, + KEY_F5, + KEY_F6, + KEY_F7, + KEY_F8, + KEY_F9, + KEY_F10, + KEY_F11, + KEY_F12, + KEY_NUMLOCK, + KEY_SCROLL, + + KEY_SHIFT, + KEY_CONTROL, + KEY_ALT, + + KEY_EQUALS, // only occurs on a Mac + KEY_CONTEXTMENU, // Windows only + + // multimedia keys + KEY_MEDIA_PLAY, + KEY_MEDIA_STOP, + KEY_MEDIA_PREV, + KEY_MEDIA_NEXT, + KEY_VOLUME_UP, + KEY_VOLUME_DOWN, + + KEY_F13, + KEY_F14, + KEY_F15, + KEY_F16, + KEY_F17, + KEY_F18, + KEY_F19, + + VKEY_FIRST_CODE = KEY_BACK, + VKEY_LAST_CODE = KEY_F19, + + VKEY_FIRST_ASCII = 128 + /* + KEY_0 - KEY_9 are the same as ASCII '0' - '9' (0x30 - 0x39) + FIRST_ASCII + KEY_A - KEY_Z are the same as ASCII 'A' - 'Z' (0x41 - 0x5A) + FIRST_ASCII + */ +}; + +//------------------------------------------------------------------------------ +inline tchar VirtualKeyCodeToChar (uint8 vKey) +{ + if (vKey >= VKEY_FIRST_ASCII) + return (tchar)(vKey - VKEY_FIRST_ASCII + 0x30); + else if (vKey == KEY_SPACE) + return ' '; + return 0; +} + +//------------------------------------------------------------------------------ +inline uint8 CharToVirtualKeyCode (tchar character) +{ + if ((character >= 0x30 && character <= 0x39) || (character >= 0x41 && character <= 0x5A)) + return (uint8)(character - 0x30 + VKEY_FIRST_ASCII); + if (character == ' ') + return (uint8)KEY_SPACE; + return 0; +} + +//------------------------------------------------------------------------------ +enum KeyModifier +{ + kShiftKey = 1 << 0, ///< same on both PC and Mac + kAlternateKey = 1 << 1, ///< same on both PC and Mac + kCommandKey = 1 << 2, ///< windows ctrl key; mac cmd key (apple button) + kControlKey = 1 << 3 ///< windows: not assigned, mac: ctrl key +}; + +//------------------------------------------------------------------------ +struct KeyCode +{ + tchar character; + uint8 virt; + uint8 modifier; + + explicit KeyCode (tchar character = 0, uint8 virt = 0, uint8 modifier = 0) + : character (character), virt (virt), modifier (modifier) + { + } +}; + +//------------------------------------------------------------------------ +} // namespace Steinberg diff --git a/VST3_SDK/pluginterfaces/base/pluginbasefwd.h b/VST3_SDK/pluginterfaces/base/pluginbasefwd.h new file mode 100644 index 0000000000..2364bbb6b6 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/pluginbasefwd.h @@ -0,0 +1,32 @@ +//------------------------------------------------------------------------ +// Project : SDK Base +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/pluginbasefwd.h +// Created by : Steinberg, 10/2014 +// Description : Forward declarations for pluginterfaces base module +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +namespace Steinberg { + +class FUnknown; +class FUID; + +template class IPtr; + +class ICloneable; +class IDependent; +class IUpdateHandler; + +class IBStream; + +} // Steinberg diff --git a/VST3_SDK/pluginterfaces/base/smartpointer.h b/VST3_SDK/pluginterfaces/base/smartpointer.h new file mode 100644 index 0000000000..2062aa9f49 --- /dev/null +++ b/VST3_SDK/pluginterfaces/base/smartpointer.h @@ -0,0 +1,351 @@ +//----------------------------------------------------------------------------- +// Project : SDK Core +// +// Category : SDK Core Interfaces +// Filename : pluginterfaces/base/smartpointer.h +// Created by : Steinberg, 01/2004 +// Description : Basic Interface +// +//----------------------------------------------------------------------------- +// This file is part of a Steinberg SDK. It is subject to the license terms +// in the LICENSE file found in the top-level directory of this distribution +// and at www.steinberg.net/sdklicenses. +// No part of the SDK, including this file, may be copied, modified, propagated, +// or distributed except according to the terms contained in the LICENSE file. +//----------------------------------------------------------------------------- + +#pragma once + +#include "pluginterfaces/base/fplatform.h" +#if SMTG_CPP11_STDLIBSUPPORT +#include +#endif + +//------------------------------------------------------------------------ +namespace Steinberg { + +//------------------------------------------------------------------------ +// IPtr +//------------------------------------------------------------------------ +/** IPtr - Smart pointer template class. + \ingroup pluginBase + + - can be used as an I* pointer + - handles refCount of the interface + - Usage example: + \code + IPtr path (sharedPath); + if (path) + path->ascend (); + \endcode + */ +//------------------------------------------------------------------------ +template +class IPtr +{ +public: +//------------------------------------------------------------------------ + inline IPtr (I* ptr, bool addRef = true); + inline IPtr (const IPtr&); + + template + inline IPtr (const IPtr& other) : ptr (other.get ()) + { + if (ptr) + ptr->addRef (); + } + + inline IPtr (); + inline ~IPtr (); + + inline I* operator= (I* ptr); + + inline IPtr& operator= (const IPtr& other); + + template + inline IPtr& operator= (const IPtr& other) + { + operator= (other.get ()); + return *this; + } + + inline operator I* () const { return ptr; } // act as I* + inline I* operator-> () const { return ptr; } // act as I* + + inline I* get () const { return ptr; } + +#if SMTG_CPP11_STDLIBSUPPORT + inline IPtr (IPtr&& movePtr) : ptr (nullptr) { *this = std::move (movePtr); } + inline IPtr& operator= (IPtr&& movePtr) + { + if (ptr) + ptr->release (); + ptr = movePtr.ptr; + movePtr.ptr = nullptr; + return *this; + } +#endif +//------------------------------------------------------------------------ +protected: + I* ptr; +}; + +//------------------------------------------------------------------------ +template +inline IPtr::IPtr (I* _ptr, bool addRef) : ptr (_ptr) +{ + if (ptr && addRef) + ptr->addRef (); +} + +//------------------------------------------------------------------------ +template +inline IPtr::IPtr (const IPtr& other) : ptr (other.ptr) +{ + if (ptr) + ptr->addRef (); +} + +//------------------------------------------------------------------------ +template +inline IPtr::IPtr () : ptr (0) +{ +} + +//------------------------------------------------------------------------ +template +inline IPtr::~IPtr () +{ + if (ptr) + ptr->release (); +} + +//------------------------------------------------------------------------ +template +inline I* IPtr::operator= (I* _ptr) +{ + if (_ptr != ptr) + { + if (ptr) + ptr->release (); + ptr = _ptr; + if (ptr) + ptr->addRef (); + } + return ptr; +} + +//------------------------------------------------------------------------ +template +inline IPtr& IPtr::operator= (const IPtr& _ptr) +{ + operator= (_ptr.ptr); + return *this; +} + +//------------------------------------------------------------------------ +/** OPtr - "owning" smart pointer used for newly created FObjects. + \ingroup pluginBase + + FUnknown implementations are supposed to have a refCount of 1 right after creation. + So using an IPtr on newly created objects would lead to a leak. + Instead the OPtr can be used in this case. \n + Example: + \code + OPtr path = FHostCreate (IPath, hostClasses); + // no release is needed... + \endcode + The assignment operator takes ownership of a new object and releases the old. + So its safe to write: + \code + OPtr path = FHostCreate (IPath, hostClasses); + path = FHostCreate (IPath, hostClasses); + path = 0; + \endcode + This is the difference to using an IPtr with addRef=false. + \code + // DONT DO THIS: + IPtr path (FHostCreate (IPath, hostClasses), false); + path = FHostCreate (IPath, hostClasses); + path = 0; + \endcode + This will lead to a leak! + */ +//------------------------------------------------------------------------ +template +class OPtr : public IPtr +{ +public: +//------------------------------------------------------------------------ + inline OPtr (I* p) : IPtr (p, false) {} + inline OPtr (const IPtr& p) : IPtr (p) {} + inline OPtr (const OPtr& p) : IPtr (p) {} + inline OPtr () {} + inline I* operator= (I* _ptr) + { + if (_ptr != this->ptr) + { + if (this->ptr) + this->ptr->release (); + this->ptr = _ptr; + } + return this->ptr; + } +}; + +//------------------------------------------------------------------------ +/** Assigning newly created object to an IPtr. + Example: + \code + IPtr path = owned (FHostCreate (IPath, hostClasses)); + \endcode + which is a slightly shorter form of writing: + \code + IPtr path = OPtr (FHostCreate (IPath, hostClasses)); + \endcode + */ +template +IPtr owned (I* p) +{ + return IPtr (p, false); +} + +/** Assigning shared object to an IPtr. + Example: + \code + IPtr path = shared (iface.getXY ()); + \endcode + */ +template +IPtr shared (I* p) +{ + return IPtr (p, true); +} + +#if SMTG_CPP11_STDLIBSUPPORT +//------------------------------------------------------------------------ +// Ownership functionality +//------------------------------------------------------------------------ +namespace SKI { +namespace Detail { +struct Adopt; +} // Detail + +/** Strong typedef for shared reference counted objects. + * Use SKI::adopt to unwrap the provided object. + * @tparam T Referenced counted type. + */ +template +class Shared +{ + friend struct Detail::Adopt; + T* obj = nullptr; +}; + +/** Strong typedef for transferring the ownership of reference counted objects. + * Use SKI::adopt to unwrap the provided object. + * After calling adopt the reference in this object is null. + * @tparam T Referenced counted type. + */ +template +class Owned +{ + friend struct Detail::Adopt; + T* obj = nullptr; +}; + +/** Strong typedef for using reference counted objects. + * Use SKI::adopt to unwrap the provided object. + * After calling adopt the reference in this object is null. + * @tparam T Referenced counted type. + */ +template +class Used +{ + friend struct Detail::Adopt; + T* obj = nullptr; +}; + +namespace Detail { + +struct Adopt +{ + template + static IPtr adopt (Shared& ref) + { + using Steinberg::shared; + return shared (ref.obj); + } + + template + static IPtr adopt (Owned& ref) + { + using Steinberg::owned; + IPtr out = owned (ref.obj); + ref.obj = nullptr; + return out; + } + + template + static T* adopt (Used& ref) + { + return ref.obj; + } + + template