Remove support for custom class names as per Syphon#88

Closes Syphon#88
vkedwardli · Apr 11, 2023 · 8262732 · 8262732
1 parent fc4f4a2
commit 8262732
Show file tree

Hide file tree

Showing 28 changed files with 70 additions and 309 deletions.
diff --git a/Building Syphon.md b/Building Syphon.md
@@ -1,5 +1 @@
- We support custom framework builds with unique class names to allow the framework to be embedded in a plugin without conflict with any other loaded instances.
-
- To create a custom build, set ````SYPHON_UNIQUE_CLASS_NAME_PREFIX=MyPrefix```` in the Preprocessor Macros (````GCC_PREPROCESSOR_DEFINITIONS````) build setting.
-
- To build the documentation you must have [Doxygen](http://www.doxygen.org/) installed. Use the ````DOXYGEN_PATH```` build setting to set the path (the default is the Applications folder).
+To build the documentation you must have [Doxygen](http://www.doxygen.org/) installed. Use the ````DOXYGEN_PATH```` build setting to set the path (the default is the Applications folder).
diff --git a/Exported_Symbols.exp b/Exported_Symbols.exp
@@ -1,47 +1,14 @@
-//
-//    Exported Symbols.exp
-//    Syphon
-//
-//    Copyright 2010-2011 bangnoise (Tom Butterworth) & vade (Anton Marini).
-//    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.
-//
-//    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 HOLDERS 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.
-//
-//
-//    This file gets passed through the C preprocessor before it is used
-
-
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonOpenGLClient)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonClientBase)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonClient)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonOpenGLServer)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonServerBase)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonServer)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonServerDirectory)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonOpenGLImage)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonImage)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonMetalServer)
-SYPHON_UNIQUE_CLASS_SYMBOL(SyphonMetalClient)
-
+.objc_class_name_SyphonOpenGLClient
+.objc_class_name_SyphonClientBase
+.objc_class_name_SyphonClient
+.objc_class_name_SyphonOpenGLServer
+.objc_class_name_SyphonServerBase
+.objc_class_name_SyphonServer
+.objc_class_name_SyphonServerDirectory
+.objc_class_name_SyphonOpenGLImage
+.objc_class_name_SyphonImage
+.objc_class_name_SyphonMetalServer
+.objc_class_name_SyphonMetalClient
 _SyphonServerAnnounceNotification
 _SyphonServerDescriptionAppNameKey
 _SyphonServerDescriptionIconKey

diff --git a/Syphon.h b/Syphon.h
@@ -154,25 +154,6 @@
  [myClient stop];
  @endcode
  
- @section plugins Syphon.framework in a Plugin
-
- If you are using Syphon in any sort of plugin, please download the framework source and compile a version of the framework with unique class names. This avoids class-name conflicts if another plugin or the host application also embeds the Syphon framework. The framework source is set up to make this easy for you: you just need to change one build setting.
- 
- <ol>
- <li><h4>Open the framework's Xcode project.</h4>
- <p></p>
- </li>
- <li><h4>Define SYPHON_UNIQUE_CLASS_NAME_PREFIX using the Preprocessor Macros build setting.</h4>
- <p>Select the Syphon target in the project window.<br/>
- Click the Build Settings tab to display the build settings.<br/>
- Scroll down (or use the search field) to find the Preprocessor Macros (GCC_PREPROCESSOR_DEFINITIONS) setting.<br/>
- Double click the setting to add SYPHON_UNIQUE_CLASS_NAME_PREFIX=MyPluginName as a macro.
- </p></li>
- <li><h4>Build the framework.</h4>
- <p>The built framework will have custom class names. The headers alias the custom names, so you can use SyphonOpenGLServer, SyphonOpenGLClient, SyphonOpenGLImage and SyphonServerDirectory as normal in your code.<br/>
- </p></li>
- </ol>
- 
  @section help More examples and help
  
  Example projects implementing a server and client are included with the Syphon SDK. You can also examine the source to some Syphon implementations on <a href="https://github.com/Syphon">GitHub</a>.

diff --git a/Syphon.xcodeproj/project.pbxproj b/Syphon.xcodeproj/project.pbxproj
diff --git a/SyphonBuildMacros.h b/SyphonBuildMacros.h
diff --git a/SyphonCFMessageReceiver.h b/SyphonCFMessageReceiver.h
@@ -30,12 +30,6 @@
 #import <Foundation/Foundation.h>
 #import "SyphonMessageReceiver.h"
 
-#define SYPHON_CFMESSAGE_RECEIVER_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonCFMessageReceiver)
-
-@interface SYPHON_CFMESSAGE_RECEIVER_UNIQUE_CLASS_NAME : SyphonMessageReceiver
+@interface SyphonCFMessageReceiver : SyphonMessageReceiver
 
 @end
-
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonCFMessageReceiver SYPHON_CFMESSAGE_RECEIVER_UNIQUE_CLASS_NAME;
-#endif
diff --git a/SyphonCFMessageSender.h b/SyphonCFMessageSender.h
@@ -32,11 +32,5 @@
 #import "SyphonMessageQueue.h"
 #import "SyphonDispatch.h"
 
-#define SYPHON_CFMESSAGE_SENDER_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonCFMessageSender)
-
-@interface SYPHON_CFMESSAGE_SENDER_UNIQUE_CLASS_NAME : SyphonMessageSender
+@interface SyphonCFMessageSender : SyphonMessageSender
 @end
-
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonCFMessageSender SYPHON_CFMESSAGE_SENDER_UNIQUE_CLASS_NAME;
-#endif
diff --git a/SyphonClient.h b/SyphonClient.h
@@ -31,15 +31,9 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-#define SYPHON_CLIENT_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonClient)
-
 DEPRECATED_MSG_ATTRIBUTE("Use SyphonOpenGLClient")
-@interface SYPHON_CLIENT_UNIQUE_CLASS_NAME : SyphonOpenGLClient
-- (id)initWithServerDescription:(NSDictionary *)description context:(CGLContextObj)context options:(nullable NSDictionary *)options newFrameHandler:(nullable void (^)(SYPHON_CLIENT_UNIQUE_CLASS_NAME *client))handler;
+@interface SyphonClient : SyphonOpenGLClient
+- (id)initWithServerDescription:(NSDictionary *)description context:(CGLContextObj)context options:(nullable NSDictionary *)options newFrameHandler:(nullable void (^)(SyphonClient *client))handler;
 @end
 
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonClient SYPHON_CLIENT_UNIQUE_CLASS_NAME;
-#endif
-
 NS_ASSUME_NONNULL_END
diff --git a/SyphonClientBase.h b/SyphonClientBase.h
@@ -31,9 +31,7 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-#define SYPHON_CLIENT_BASE_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonClientBase)
-
-@interface SYPHON_CLIENT_BASE_UNIQUE_CLASS_NAME : NSObject
+@interface SyphonClientBase : NSObject
 /*!
  Returns a new client instance for the described server. You should check the isValid property after initialization to ensure a connection was made to the server.
  @param description Typically acquired from the shared SyphonServerDirectory, or one of Syphon's notifications.
@@ -66,8 +64,4 @@ NS_ASSUME_NONNULL_BEGIN
 @property (readonly) BOOL hasNewFrame;
 @end
 
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonClientBase SYPHON_CLIENT_BASE_UNIQUE_CLASS_NAME;
-#endif
-
 NS_ASSUME_NONNULL_END
diff --git a/SyphonClientConnectionManager.h b/SyphonClientConnectionManager.h
@@ -53,17 +53,11 @@
 - (void)invalidateFrame;
 @end
 
-#define SYPHON_CLIENT_CONNECTION_MANAGER_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonClientConnectionManager)
-
-@interface SYPHON_CLIENT_CONNECTION_MANAGER_UNIQUE_CLASS_NAME : NSObject
+@interface SyphonClientConnectionManager : NSObject
 - (id)initWithServerDescription:(NSDictionary *)description;
 @property (readonly) BOOL isValid;
 - (void)addInfoClient:(id <SyphonInfoReceiving>)client isFrameClient:(BOOL)frameClient;     // Must be
 - (void)removeInfoClient:(id <SyphonInfoReceiving>)client isFrameClient:(BOOL)frameClient;  // paired
 - (IOSurfaceRef)newSurface;
 @property (readonly) NSUInteger frameID;
 @end
-
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonClientConnectionManager SYPHON_CLIENT_CONNECTION_MANAGER_UNIQUE_CLASS_NAME;
-#endif
diff --git a/SyphonImage.h b/SyphonImage.h
@@ -31,15 +31,9 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
-#define SYPHON_IMAGE_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonImage)
-
 DEPRECATED_MSG_ATTRIBUTE("Use SyphonOpenGLImage")
-@interface SYPHON_IMAGE_UNIQUE_CLASS_NAME : SyphonOpenGLImage
+@interface SyphonImage : SyphonOpenGLImage
 
 @end
 
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonImage SYPHON_IMAGE_UNIQUE_CLASS_NAME;
-#endif
-
 NS_ASSUME_NONNULL_END
diff --git a/SyphonImageBase.h b/SyphonImageBase.h
@@ -30,9 +30,7 @@
 #import <Foundation/Foundation.h>
 #import <IOSurface/IOSurface.h>
 
-#define SYPHON_IMAGE_BASE_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonImageBase)
-
-@interface SYPHON_IMAGE_BASE_UNIQUE_CLASS_NAME : NSObject
+@interface SyphonImageBase : NSObject
 /*!
  If you implement your own subclass of SyphonImageBase, you must call this designated initializer from your own initializer.
 
@@ -43,7 +41,3 @@
 */
 - (id)initWithSurface:(IOSurfaceRef)surfaceRef NS_DESIGNATED_INITIALIZER;
 @end
-
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonImageBase SYPHON_IMAGE_BASE_UNIQUE_CLASS_NAME;
-#endif
diff --git a/SyphonMessageQueue.h b/SyphonMessageQueue.h
@@ -38,9 +38,7 @@
  
  */
 
-#define SYPHON_MESSAGE_QUEUE_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonMessageQueue)
-
-@interface SYPHON_MESSAGE_QUEUE_UNIQUE_CLASS_NAME : NSObject
+@interface SyphonMessageQueue : NSObject
 
 - (void)queue:(NSData *)content ofType:(uint32_t)type;
 /*
@@ -58,7 +56,3 @@
 @property (readwrite, assign) void *userInfo;
 
 @end
-
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonMessageQueue SYPHON_MESSAGE_QUEUE_UNIQUE_CLASS_NAME;
-#endif
diff --git a/SyphonMessageReceiver.h b/SyphonMessageReceiver.h
@@ -29,9 +29,7 @@
 
 #import <Foundation/Foundation.h>
 
-#define SYPHON_MESSAGE_RECEIVER_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonMessageReceiver)
-
-@interface SYPHON_MESSAGE_RECEIVER_UNIQUE_CLASS_NAME : NSObject
+@interface SyphonMessageReceiver : NSObject
 - (id)initForName:(NSString *)name
          protocol:(NSString *)protocolName
    allowedClasses:(NSSet<Class> *)classes
@@ -41,10 +39,6 @@
 // Always invalidate before release
 - (void)invalidate;
 @end
-@interface SYPHON_MESSAGE_RECEIVER_UNIQUE_CLASS_NAME (Subclassing)
+@interface SyphonMessageReceiver (Subclassing)
 - (void)receiveMessageWithPayload:(id)payload ofType:(uint32_t)type;
 @end
-
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonMessageReceiver SYPHON_MESSAGE_RECEIVER_UNIQUE_CLASS_NAME;
-#endif
diff --git a/SyphonMessageSender.h b/SyphonMessageSender.h
@@ -29,18 +29,12 @@
 
 #import <Foundation/Foundation.h>
 
-#define SYPHON_MESSAGE_SENDER_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonMessageSender)
-
-@interface SYPHON_MESSAGE_SENDER_UNIQUE_CLASS_NAME : NSObject
+@interface SyphonMessageSender : NSObject
 - (id)initForName:(NSString *)name protocol:(NSString *)protocolName invalidationHandler:(void (^)(void))handler;
 @property (readonly) NSString *name;
 @property (readonly) BOOL isValid;
 - (void)send:(id <NSCoding>)payload ofType:(uint32_t)type;
 @end
-@interface SYPHON_MESSAGE_SENDER_UNIQUE_CLASS_NAME (Subclassing)
+@interface SyphonMessageSender (Subclassing)
 - (void)invalidate;
 @end
-
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonMessageSender SYPHON_MESSAGE_SENDER_UNIQUE_CLASS_NAME;
-#endif
diff --git a/SyphonMetalClient.h b/SyphonMetalClient.h
@@ -31,11 +31,9 @@
 #import <Metal/Metal.h>
 #import <Syphon/SyphonClientBase.h>
 
-#define SYPHON_METAL_CLIENT_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonMetalClient)
-
 NS_ASSUME_NONNULL_BEGIN
 
-@interface SYPHON_METAL_CLIENT_UNIQUE_CLASS_NAME : SyphonClientBase
+@interface SyphonMetalClient : SyphonClientBase
 
 /*!
  Returns a new client instance for the described server. You should check the isValid property after initialization to ensure a connection was made to the server.
@@ -48,7 +46,7 @@ NS_ASSUME_NONNULL_BEGIN
 - (id)initWithServerDescription:(NSDictionary *)description
                          device:(id<MTLDevice>)device
                         options:(nullable NSDictionary *)options
-                newFrameHandler:(nullable void (^)(SYPHON_METAL_CLIENT_UNIQUE_CLASS_NAME *client))handler;
+                newFrameHandler:(nullable void (^)(SyphonMetalClient *client))handler;
 
 /*!
 Returns a MTLTexture representing the current output from the server. The texture associated with the image may continue to update when you draw with it, but you should not depend on that behaviour: call this method every time you wish to access the current server frame.
@@ -64,9 +62,4 @@ Stops the client from receiving any further frames from the server. Use of this
 
 @end
 
-
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonMetalClient SYPHON_METAL_CLIENT_UNIQUE_CLASS_NAME;
-#endif
-
 NS_ASSUME_NONNULL_END
diff --git a/SyphonMetalClient.m b/SyphonMetalClient.m
@@ -31,7 +31,7 @@
 #import "SyphonSubclassing.h"
 #import <os/lock.h>
 
-@implementation SYPHON_METAL_CLIENT_UNIQUE_CLASS_NAME
+@implementation SyphonMetalClient
 {
     os_unfair_lock _threadLock;
     id<MTLTexture> _frame;
@@ -43,7 +43,7 @@ @implementation SYPHON_METAL_CLIENT_UNIQUE_CLASS_NAME
 - (id)initWithServerDescription:(NSDictionary *)description
                          device:(id<MTLDevice>)theDevice
                         options:(NSDictionary *)options
-                   newFrameHandler:(void (^)(SYPHON_METAL_CLIENT_UNIQUE_CLASS_NAME *client))handler
+                   newFrameHandler:(void (^)(SyphonMetalClient *client))handler
 {
     self = [super initWithServerDescription:description options:options newFrameHandler:handler];
     if( self )

diff --git a/SyphonMetalServer.h b/SyphonMetalServer.h
@@ -51,8 +51,7 @@ extern NSString * const SyphonServerOptionIsPrivate;
  It is safe to access instances of this class across threads.
  */
 
-#define SYPHON_METAL_SERVER_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonMetalServer)
-@interface SYPHON_METAL_SERVER_UNIQUE_CLASS_NAME : SyphonServerBase
+@interface SyphonMetalServer : SyphonServerBase
 
 /** @name Instantiation */
 /** @{ */

diff --git a/SyphonMetalServer.m b/SyphonMetalServer.m
@@ -32,7 +32,7 @@
 #import "SyphonPrivate.h"
 #import "SyphonSubclassing.h"
 
-@implementation SYPHON_METAL_SERVER_UNIQUE_CLASS_NAME
+@implementation SyphonMetalServer
 {
     id<MTLTexture> _surfaceTexture;
     id<MTLDevice> _device;

diff --git a/SyphonOpenGLClient.h b/SyphonOpenGLClient.h
@@ -31,8 +31,6 @@
 #import <OpenGL/OpenGL.h>
 #import <Syphon/SyphonClientBase.h>
 
-#define SYPHON_OPENGL_CLIENT_UNIQUE_CLASS_NAME SYPHON_UNIQUE_CLASS_NAME(SyphonOpenGLClient)
-
 @class SyphonOpenGLImage;
 
 NS_ASSUME_NONNULL_BEGIN
@@ -45,7 +43,7 @@ NS_ASSUME_NONNULL_BEGIN
  It is safe to access instances of this class across threads, with the usual limitatiions related to OpenGL. The calls to SyphonOpenGLClient which may cause work to be done in a GL context are: -newFrameImage, -stop and -release.
  */
 
-@interface SYPHON_OPENGL_CLIENT_UNIQUE_CLASS_NAME : SyphonClientBase
+@interface SyphonOpenGLClient : SyphonClientBase
 
 /*! 
  Returns a new client instance for the described server. You should check the isValid property after initialization to ensure a connection was made to the server.
@@ -55,7 +53,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param handler A block which is invoked when a new frame becomes available. handler may be nil. This block may be invoked on a thread other than that on which the client was created.
  @returns A newly initialized SyphonOpenGLClient object, or nil if a client could not be created.
 */
-- (id)initWithServerDescription:(NSDictionary *)description context:(CGLContextObj)context options:(nullable NSDictionary *)options newFrameHandler:(nullable void (^)(SYPHON_OPENGL_CLIENT_UNIQUE_CLASS_NAME *client))handler;
+- (id)initWithServerDescription:(NSDictionary *)description context:(CGLContextObj)context options:(nullable NSDictionary *)options newFrameHandler:(nullable void (^)(SyphonOpenGLClient *client))handler;
 
 /*!
  Returns the CGLContextObj associated with the client.
@@ -97,8 +95,4 @@ NS_ASSUME_NONNULL_BEGIN
 
 @end
 
-#if defined(SYPHON_USE_CLASS_ALIAS)
-@compatibility_alias SyphonOpenGLClient SYPHON_OPENGL_CLIENT_UNIQUE_CLASS_NAME;
-#endif
-
 NS_ASSUME_NONNULL_END