serenity/AK/Base64.h

/*
 * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/ByteBuffer.h>
#include <AK/DeprecatedString.h>
#include <AK/Error.h>
#include <AK/StringView.h>

namespace AK {

[[nodiscard]] size_t calculate_base64_decoded_length(StringView);

[[nodiscard]] size_t calculate_base64_encoded_length(ReadonlyBytes);

[[nodiscard]] ErrorOr<ByteBuffer> decode_base64(StringView);

[[nodiscard]] DeprecatedString encode_base64(ReadonlyBytes);
}

#if USING_AK_GLOBALLY
using AK::decode_base64;
using AK::encode_base64;
#endif
AK: Add a simple and inefficient Base64 decoder 2020-04-26 20:49:19 +00:00			`/*`
			`* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>`
			`*`
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt * 2021-04-22 08:24:48 +00:00			`* SPDX-License-Identifier: BSD-2-Clause`
AK: Add a simple and inefficient Base64 decoder 2020-04-26 20:49:19 +00:00			`*/`

Meta: Add a script check the presence of "#pragma once" in header files .. and make travis run it. I renamed check-license-headers.sh to check-style.sh and expanded it so that it now also checks for the presence of "#pragma once" in .h files. It also checks the presence of a (single) blank line above and below the "#pragma once" line. I also added "#pragma once" to all the files that need it: even the ones we are not check. I also added/removed blank lines in order to make the script not fail. I also ran clang-format on the files I modified. 2020-05-28 18:40:53 +00:00			`#pragma once`

Base64: Pre-allocate size of input and output Problem: - Output of decode and encode grow as the decode and encode happen. This is inefficient because a large size will require many reallocations. - `const` qualifiers are missing on variables which are not intended to change. Solution: - Since the size of the decoded or encoded message is known prior to starting, calculate the size and set the output to that size immediately. All appends will not incur the reallocation overhead. - Add `const` qualifiers to show intent. 2020-10-13 14:48:48 +00:00			`#include <AK/ByteBuffer.h>`
AK+Everywhere: Rename String to DeprecatedString We have a new, improved string type coming up in AK (OOM aware, no null state), and while it's going to use UTF-8, the name UTF8String is a mouthful - so let's free up the String name by renaming the existing class. Making the old one have an annoying name will hopefully also help with quick adoption :^) 2022-12-04 18:02:33 +00:00			`#include <AK/DeprecatedString.h>`
AK+Userland: Make AK::decode_hex() return ErrorOr This lets us propagate the reason why it failed up to the caller. :^) 2022-01-20 17:01:39 +00:00			`#include <AK/Error.h>`
Base64: Pre-allocate size of input and output Problem: - Output of decode and encode grow as the decode and encode happen. This is inefficient because a large size will require many reallocations. - `const` qualifiers are missing on variables which are not intended to change. Solution: - Since the size of the decoded or encoded message is known prior to starting, calculate the size and set the output to that size immediately. All appends will not incur the reallocation overhead. - Add `const` qualifiers to show intent. 2020-10-13 14:48:48 +00:00			`#include <AK/StringView.h>`
AK: Add a simple and inefficient Base64 decoder 2020-04-26 20:49:19 +00:00
			`namespace AK {`

AK: Add `nodiscard` attribute to Base64 functions 2022-06-26 16:20:09 +00:00			`[[nodiscard]] size_t calculate_base64_decoded_length(StringView);`
Base64: Pre-allocate size of input and output Problem: - Output of decode and encode grow as the decode and encode happen. This is inefficient because a large size will require many reallocations. - `const` qualifiers are missing on variables which are not intended to change. Solution: - Since the size of the decoded or encoded message is known prior to starting, calculate the size and set the output to that size immediately. All appends will not incur the reallocation overhead. - Add `const` qualifiers to show intent. 2020-10-13 14:48:48 +00:00
AK: Add `nodiscard` attribute to Base64 functions 2022-06-26 16:20:09 +00:00			`[[nodiscard]] size_t calculate_base64_encoded_length(ReadonlyBytes);`
Base64: Pre-allocate size of input and output Problem: - Output of decode and encode grow as the decode and encode happen. This is inefficient because a large size will require many reallocations. - `const` qualifiers are missing on variables which are not intended to change. Solution: - Since the size of the decoded or encoded message is known prior to starting, calculate the size and set the output to that size immediately. All appends will not incur the reallocation overhead. - Add `const` qualifiers to show intent. 2020-10-13 14:48:48 +00:00
AK: Add `nodiscard` attribute to Base64 functions 2022-06-26 16:20:09 +00:00			`[[nodiscard]] ErrorOr<ByteBuffer> decode_base64(StringView);`
AK: Add a simple and inefficient Base64 encoder The test cases are taken from RFC 4648. 2020-06-13 02:09:31 +00:00
AK+Everywhere: Rename String to DeprecatedString We have a new, improved string type coming up in AK (OOM aware, no null state), and while it's going to use UTF-8, the name UTF8String is a mouthful - so let's free up the String name by renaming the existing class. Making the old one have an annoying name will hopefully also help with quick adoption :^) 2022-12-04 18:02:33 +00:00			`[[nodiscard]] DeprecatedString encode_base64(ReadonlyBytes);`
AK: Add a simple and inefficient Base64 decoder 2020-04-26 20:49:19 +00:00			`}`

AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types. 2022-11-26 11:18:30 +00:00			`#if USING_AK_GLOBALLY`
AK: Add a simple and inefficient Base64 decoder 2020-04-26 20:49:19 +00:00			`using AK::decode_base64;`
AK: Add a simple and inefficient Base64 encoder The test cases are taken from RFC 4648. 2020-06-13 02:09:31 +00:00			`using AK::encode_base64;`
AK: Make it possible to not `using` AK classes into the global namespace This patch adds the `USING_AK_GLOBALLY` macro which is enabled by default, but can be overridden by build flags. This is a step towards integrating Jakt and AK types. 2022-11-26 11:18:30 +00:00			`#endif`