Skip to content

Commit

Permalink
Everywhere: Remove klog(), dbg() and purge all LogStream usage :^)
Browse files Browse the repository at this point in the history
Good-bye LogStream. Long live AK::Format!
  • Loading branch information
awesomekling committed Mar 12, 2021
1 parent 423ed53 commit ef1e5db
Show file tree
Hide file tree
Showing 209 changed files with 163 additions and 836 deletions.
6 changes: 0 additions & 6 deletions AK/ByteBuffer.h
Original file line number Diff line number Diff line change
Expand Up @@ -325,12 +325,6 @@ inline NonnullRefPtr<ByteBufferImpl> ByteBufferImpl::copy(const void* data, size
return ::adopt(*new ByteBufferImpl(data, size));
}

inline const LogStream& operator<<(const LogStream& stream, const ByteBuffer& value)
{
stream.write((const char*)value.data(), value.size());
return stream;
}

}

using AK::ByteBuffer;
11 changes: 5 additions & 6 deletions AK/Format.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,13 @@
#include <AK/GenericLexer.h>
#include <AK/String.h>
#include <AK/StringBuilder.h>
#include <AK/kstdio.h>
#include <ctype.h>

#if defined(__serenity__) && !defined(KERNEL)
# include <serenity.h>
#endif

#ifdef KERNEL
# include <Kernel/Process.h>
# include <Kernel/Thread.h>
Expand Down Expand Up @@ -416,12 +421,6 @@ void vformat(StringBuilder& builder, StringView fmtstr, TypeErasedFormatParams p

vformat_impl(params, fmtbuilder, parser);
}
void vformat(const LogStream& stream, StringView fmtstr, TypeErasedFormatParams params)
{
StringBuilder builder;
vformat(builder, fmtstr, params);
stream << builder.to_string();
}

void StandardFormatter::parse(TypeErasedFormatParams& params, FormatParser& parser)
{
Expand Down
1 change: 0 additions & 1 deletion AK/Format.h
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,6 @@ struct Formatter<std::nullptr_t> : Formatter<FlatPtr> {
};

void vformat(StringBuilder&, StringView fmtstr, TypeErasedFormatParams);
void vformat(const LogStream& stream, StringView fmtstr, TypeErasedFormatParams);

#ifndef KERNEL
void vout(FILE*, StringView fmtstr, TypeErasedFormatParams, bool newline = false);
Expand Down
4 changes: 0 additions & 4 deletions AK/Forward.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,10 @@ namespace AK {

class Bitmap;
class ByteBuffer;
class DebugLogStream;
class IPv4Address;
class JsonArray;
class JsonObject;
class JsonValue;
class LogStream;
class StackInfo;
class String;
class StringBuilder;
Expand Down Expand Up @@ -143,7 +141,6 @@ using AK::ByteBuffer;
using AK::Bytes;
using AK::CircularDuplexStream;
using AK::CircularQueue;
using AK::DebugLogStream;
using AK::DoublyLinkedList;
using AK::DuplexMemoryStream;
using AK::FlyString;
Expand All @@ -158,7 +155,6 @@ using AK::IPv4Address;
using AK::JsonArray;
using AK::JsonObject;
using AK::JsonValue;
using AK::LogStream;
using AK::NonnullOwnPtr;
using AK::NonnullOwnPtrVector;
using AK::NonnullRefPtr;
Expand Down
1 change: 0 additions & 1 deletion AK/HashTable.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
#pragma once

#include <AK/HashFunctions.h>
#include <AK/LogStream.h>
#include <AK/StdLibExtras.h>
#include <AK/Types.h>
#include <AK/kmalloc.h>
Expand Down
1 change: 1 addition & 0 deletions AK/IDAllocator.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@

#pragma once

#include <AK/Forward.h>
#include <AK/HashTable.h>

namespace AK {
Expand Down
6 changes: 0 additions & 6 deletions AK/IPv4Address.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
#pragma once

#include <AK/Endian.h>
#include <AK/LogStream.h>
#include <AK/Optional.h>
#include <AK/String.h>
#include <AK/StringView.h>
Expand Down Expand Up @@ -143,11 +142,6 @@ struct Traits<IPv4Address> : public GenericTraits<IPv4Address> {
static constexpr unsigned hash(const IPv4Address& address) { return int_hash(address.to_u32()); }
};

inline const LogStream& operator<<(const LogStream& stream, const IPv4Address& value)
{
return stream << value.to_string();
}

template<>
struct Formatter<IPv4Address> : Formatter<String> {
void format(FormatBuilder& builder, IPv4Address value)
Expand Down
240 changes: 0 additions & 240 deletions AK/LogStream.cpp
Original file line number Diff line number Diff line change
@@ -1,240 +0,0 @@
/*
* Copyright (c) 2018-2020, Andreas Kling <[email protected]>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* 2. 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 HOLDER 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 <AK/FlyString.h>
#include <AK/LogStream.h>
#include <AK/String.h>
#include <AK/StringBuilder.h>
#include <AK/StringView.h>

#ifdef KERNEL
# include <Kernel/Process.h>
# include <Kernel/Thread.h>
#endif

namespace AK {

const LogStream& operator<<(const LogStream& stream, const String& value)
{
stream.write(value.characters(), value.length());
return stream;
}

const LogStream& operator<<(const LogStream& stream, const FlyString& value)
{
return stream << value.view();
}

const LogStream& operator<<(const LogStream& stream, const StringView& value)
{
stream.write(value.characters_without_null_termination(), value.length());
return stream;
}

const LogStream& operator<<(const LogStream& stream, int value)
{
char buffer[32];
snprintf(buffer, sizeof(buffer), "%d", value);
return stream << buffer;
}

const LogStream& operator<<(const LogStream& stream, long value)
{
char buffer[32];
snprintf(buffer, sizeof(buffer), "%ld", value);
return stream << buffer;
}

const LogStream& operator<<(const LogStream& stream, long long value)
{
char buffer[32];
snprintf(buffer, sizeof(buffer), "%lld", value);
return stream << buffer;
}

const LogStream& operator<<(const LogStream& stream, unsigned value)
{
char buffer[32];
snprintf(buffer, sizeof(buffer), "%u", value);
return stream << buffer;
}

const LogStream& operator<<(const LogStream& stream, unsigned long long value)
{
char buffer[32];
snprintf(buffer, sizeof(buffer), "%llu", value);
return stream << buffer;
}

const LogStream& operator<<(const LogStream& stream, unsigned long value)
{
char buffer[32];
snprintf(buffer, sizeof(buffer), "%lu", value);
return stream << buffer;
}

const LogStream& operator<<(const LogStream& stream, const void* value)
{
char buffer[32];
snprintf(buffer, sizeof(buffer), "%p", value);
return stream << buffer;
}

#if defined(__serenity__) && !defined(KERNEL)
static TriState got_process_name = TriState::Unknown;
static char process_name_buffer[256];
#endif

DebugLogStream dbg()
{
DebugLogStream stream;

// FIXME: This logic is redundant with the stuff in Format.cpp.
#if defined(__serenity__) && !defined(KERNEL)
if (got_process_name == TriState::Unknown) {
if (get_process_name(process_name_buffer, sizeof(process_name_buffer)) == 0)
got_process_name = TriState::True;
else
got_process_name = TriState::False;
}
if (got_process_name == TriState::True)
stream << "\033[33;1m" << process_name_buffer << '(' << getpid() << ")\033[0m: ";
#endif
#if defined(__serenity__) && defined(KERNEL)
if (Kernel::Processor::is_initialized() && Kernel::Thread::current())
stream << "\033[34;1m[#" << Kernel::Processor::id() << " " << *Kernel::Thread::current() << "]\033[0m: ";
else
stream << "\033[36;1m[Kernel]\033[0m: ";
#endif
return stream;
}

#ifdef KERNEL
KernelLogStream klog()
{
KernelLogStream stream;
if (Kernel::Processor::is_initialized() && Kernel::Thread::current())
stream << "\033[34;1m[#" << Kernel::Processor::id() << " " << *Kernel::Thread::current() << "]\033[0m: ";
else
stream << "\033[36;1m[Kernel]\033[0m: ";
return stream;
}
#else
DebugLogStream klog()
{
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wdeprecated-declarations"
return dbg();
# pragma GCC diagnostic pop
}
#endif

#ifdef KERNEL
KernelLogStream::~KernelLogStream()
{
if (!empty()) {
char newline = '\n';
write(&newline, 1);
kernelputstr(reinterpret_cast<char*>(data()), size());
}
}
#endif

DebugLogStream::~DebugLogStream()
{
if (!empty() && s_enabled) {
char newline = '\n';
write(&newline, 1);
dbgputstr(reinterpret_cast<char*>(data()), size());
}
}

void DebugLogStream::set_enabled(bool enabled)
{
s_enabled = enabled;
}

bool DebugLogStream::is_enabled()
{
return s_enabled;
}

bool DebugLogStream::s_enabled = true;

#ifndef KERNEL
const LogStream& operator<<(const LogStream& stream, double value)
{
return stream << String::format("%.4f", value);
}

const LogStream& operator<<(const LogStream& stream, float value)
{
return stream << String::format("%.4f", value);
}
#endif

void dump_bytes(ReadonlyBytes bytes)
{
StringBuilder builder;

u8 buffered_byte = 0;
size_t nrepeat = 0;
const char* prefix = "";

auto flush = [&]() {
if (nrepeat > 0) {
if (nrepeat == 1)
builder.appendff("{}{:#02x}", prefix, static_cast<int>(buffered_byte));
else
builder.appendff("{}{} * {:#02x}", prefix, nrepeat, static_cast<int>(buffered_byte));

nrepeat = 0;
prefix = ", ";
}
};

builder.append("{ ");

for (auto byte : bytes) {
if (nrepeat > 0) {
if (byte != buffered_byte)
flush();

buffered_byte = byte;
nrepeat++;
} else {
buffered_byte = byte;
nrepeat = 1;
}
}
flush();

builder.append(" }");

dbgln("{}", builder.string_view());
}

}
Loading

0 comments on commit ef1e5db

Please sign in to comment.