OFStdIOStream.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2026 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * 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
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */

#import "OFStream.h"
#import "OFKernelEventObserver.h"

#ifdef OF_AMIGAOS
# include <dos/dos.h>
#endif

OF_ASSUME_NONNULL_BEGIN

@class OFColor;

@interface OFStdIOStream: OFStream
#if !defined(OF_WINDOWS) && !defined(OF_AMIGAOS) && !defined(OF_WII_U)
    <OFReadyForReadingObserving, OFReadyForWritingObserving>
#endif
{
#if defined(OF_AMIGAOS)
    BPTR _handle;
    bool _closable;
#elif !defined(OF_WII_U)
    int _fd;
#endif
    bool _atEndOfStream;
    int _colors;
    OFColor *_Nullable _foregroundColor, *_Nullable _backgroundColor;
    bool _bold, _italic, _underlined, _blinking;
    uintptr_t _cursorVisible;  /* Change type on ABI bump */
    OF_RESERVE_IVARS(OFStdIOStream, 3)
}

@property (readonly, nonatomic) bool hasTerminal;

@property (readonly, nonatomic) int columns;

@property (readonly, nonatomic) int rows;

@property (readonly, nonatomic) int colors;

@property OF_NULLABLE_PROPERTY (retain, nonatomic) OFColor *foregroundColor;

@property OF_NULLABLE_PROPERTY (retain, nonatomic) OFColor *backgroundColor;

@property (nonatomic, getter=isBold) bool bold;

@property (nonatomic, getter=isItalic) bool italic;

@property (nonatomic, getter=isUnderlined) bool underlined;

@property (nonatomic, getter=isBlinking) bool blinking;

@property (nonatomic, getter=isCursorVisible) bool cursorVisible;

#if defined(OF_WII) || defined(OF_NINTENDO_DS) || defined(OF_NINTENDO_3DS) || \
    defined(DOXYGEN)

+ (void)setUpConsole;
#endif

- (instancetype)init OF_UNAVAILABLE;

- (void)reset;

- (void)clear;

- (void)eraseLine;

- (void)setCursorColumn: (unsigned int)column;

- (void)setCursorPosition: (OFPoint)position;

- (void)setRelativeCursorPosition: (OFPoint)position;

- (void)setProgressIndicator: (float)progress;

- (void)removeProgressIndicator;
@end

#ifdef __cplusplus
extern "C" {
#endif

extern OFStdIOStream *_Nullable OFStdIn;

extern OFStdIOStream *_Nullable OFStdOut;

extern OFStdIOStream *_Nullable OFStdErr;

extern void OFLog(OFConstantString *format, ...);

extern void OFLogV(OFConstantString *format, va_list arguments);
#ifdef __cplusplus
}
#endif

OF_ASSUME_NONNULL_END