VLCLogging.h

/*****************************************************************************
 * VLCLogging.h: [Mobile/TV]VLCKit.framework VLCLogging header
 *****************************************************************************
 * Copyright (C) 2022 VLC authors and VideoLAN
 * $Id$
 *
 * Authors: Maxime Chapelet <umxprime # videolabs.io>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/
 
#ifndef VLCLogging_h
#define VLCLogging_h
 
NS_ASSUME_NONNULL_BEGIN
 
typedef NS_ENUM(int, VLCLogLevel) {
    kVLCLogLevelError = 0,  
    kVLCLogLevelWarning,    
    kVLCLogLevelInfo,       
    kVLCLogLevelDebug       
};
 
@interface VLCLogContext: NSObject
@property (nonatomic, readonly) uintptr_t objectId;
 
@property (nonatomic, readonly) NSString *objectType;
 
@property (nonatomic, readonly) NSString *module;
 
@property (nonatomic, readonly, nullable) NSString *header;
 
@property (nonatomic, readonly, nullable) NSString *file;
 
@property (nonatomic, readonly) int line;
 
@property (nonatomic, readonly, nullable) NSString *function;
 
@property (nonatomic, readonly) unsigned long threadId;
 
@end
 
typedef NS_OPTIONS(int, VLCLogContextFlag) {
    kVLCLogLevelContextNone = 0,                
    kVLCLogLevelContextModule = 1<<0,           
    kVLCLogLevelContextFileLocation = 1<<1,     
    kVLCLogLevelContextCallingFunction = 1<<2,  
    kVLCLogLevelContextCustom = 1<<3,           
    kVLCLogLevelContextAll = 0xF                
};
 
@protocol VLCLogMessageFormatting <NSObject>
 
@property (readwrite, nonatomic) VLCLogContextFlag contextFlags;
 
@property (readwrite, nonatomic, nullable) id customContext;
 
@required
- (NSString *)formatWithMessage:(NSString *)message
                       logLevel:(VLCLogLevel)level
                        context:(nullable VLCLogContext *)context;
 
@end
 
@protocol VLCLogging <NSObject>
@required
@property (readwrite, nonatomic) VLCLogLevel level;
 
- (void)handleMessage:(NSString *)message
             logLevel:(VLCLogLevel)level
              context:(nullable VLCLogContext *)context;
@end
 
@protocol VLCFormattedMessageLogging <VLCLogging>
@required
 
@property (nonatomic, readwrite) id<VLCLogMessageFormatting> formatter;
 
@end
 
NS_ASSUME_NONNULL_END
 
#endif /* VLCLogHandler_h */