skia2/include/utils/SkBase64.h
Ben Wagner b06ebee1e8 Make SkBase64 interface less unpleasant.
Change SkBase64::decode interface completely and better document
how to use. Unfortunately there are users of ::decode (and they are
leaking) so will need to keep the old interface until users can be
updated.

Change-Id: I214b771136d78fef758c5d0d9ec302f956f6e4f0
Reviewed-on: https://skia-review.googlesource.com/c/skia/+/351201
Reviewed-by: Mike Reed <reed@google.com>
Commit-Queue: Ben Wagner <bungeman@google.com>
2021-01-08 20:28:19 +00:00

67 lines
2.0 KiB
C++

/*
* Copyright 2006 The Android Open Source Project
*
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef SkBase64_DEFINED
#define SkBase64_DEFINED
#include "include/core/SkTypes.h"
struct SkBase64 {
public:
enum Error {
kNoError,
kPadError,
kBadCharError
};
/** @deprecated */
SkBase64();
/** @deprecated, required user to `delete skbase64.getData()` */
Error decode(const char* src, size_t length);
/** @deprecated */
char* getData() { return fData; }
/** @deprecated */
size_t getDataSize() { return fLength; }
/**
Base64 encodes src into dst.
Normally this is called once with 'dst' nullptr to get the required size, then again with an
allocated 'dst' pointer to do the actual encoding.
@param dst nullptr or a pointer to a buffer large enough to receive the result
@param encode nullptr for default encoding or a pointer to at least 65 chars.
encode[64] will be used as the pad character.
Encodings other than the default encoding cannot be decoded.
@return the required length of dst for encoding.
*/
static size_t Encode(const void* src, size_t length, void* dst, const char* encode = nullptr);
/**
Base64 decodes src into dst.
Normally this is called once with 'dst' nullptr to get the required size, then again with an
allocated 'dst' pointer to do the actual encoding.
@param dst nullptr or a pointer to a buffer large enough to receive the result
@param dstLength assigned the length dst is required to be. Must not be nullptr.
*/
static Error SK_WARN_UNUSED_RESULT Decode(const void* src, size_t srcLength,
void* dst, size_t* dstLength);
private:
/** @deprecated */
size_t fLength;
/** @deprecated */
char* fData;
};
#endif // SkBase64_DEFINED