logFileStreamOutput.hpp

/*
 * Copyright (c) 2015, 2022, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 *
*/
#ifndef SHARE_LOGGING_LOGFILESTREAMOUTPUT_HPP
#defineSHARE_LOGGING_LOGFILESTREAMOUTPUT_HPP

#include"logging/logDecorators.hpp"
#include"logging/logOutput.hpp"
#include"runtime/os.hpp"
#include"utilities/globalDefinitions.hpp"

classLogDecorations;

// Base class for all FileStream-based log outputs.
classLogFileStreamOutput : publicLogOutput {
private:
staticconstchar* const FoldMultilinesOptionKey;
bool _fold_multilines;
bool _write_error_is_shown;

protected:
 FILE* _stream;
size_t _decorator_padding[LogDecorators::Count];

LogFileStreamOutput(FILE *stream) : _fold_multilines(false), _write_error_is_shown(false), _stream(stream) {
for (size_t i = 0; i < LogDecorators::Count; i++) {
 _decorator_padding[i] = 0;
 }
 }

intwrite_decorations(const LogDecorations& decorations);
intwrite_internal(const LogDecorations& decorations, constchar* msg);
boolflush();

public:
virtualboolset_option(constchar* key, constchar* value, outputStream* errstream);
virtualintwrite(const LogDecorations& decorations, constchar* msg);
virtualintwrite(LogMessageBuffer::Iterator msg_iterator);
// Write API used by AsyncLogWriter
virtualintwrite_blocking(const LogDecorations& decorations, constchar* msg);
virtualvoiddescribe(outputStream* out);
};

classLogStdoutOutput : publicLogFileStreamOutput {
friendclassLogFileStreamInitializer;
private:
virtualboolinitialize(constchar* options, outputStream* errstream) {
returnfalse;
 }
public:
LogStdoutOutput() : LogFileStreamOutput(stdout) {}
virtualconstchar* name() const {
return"stdout";
 }
};

classLogStderrOutput : publicLogFileStreamOutput {
friendclassLogFileStreamInitializer;
private:
virtualboolinitialize(constchar* options, outputStream* errstream) {
returnfalse;
 }
public:
LogStderrOutput() : LogFileStreamOutput(stderr) {}
virtualconstchar* name() const {
return"stderr";
 }
};

#endif// SHARE_LOGGING_LOGFILESTREAMOUTPUT_HPP