third_party/WebKit/Source/wtf/text/Base64.h

   1 /*
   2  * Copyright (C) 2006 Alexey Proskuryakov <ap@webkit.org>
   3  * Copyright (C) 2010 Patrick Gansterer <paroga@paroga.com>
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  */
  26
  27 #ifndef Base64_h
  28 #define Base64_h
  29
  30 #include "wtf/Vector.h"
  31 #include "wtf/WTFExport.h"
  32 #include "wtf/text/CString.h"
  33 #include "wtf/text/WTFString.h"
  34
  35 namespace WTF {
  36
  37 enum Base64EncodePolicy {
  38     Base64DoNotInsertLFs,
  39     Base64InsertLFs
  40 };
  41
  42 enum Base64DecodePolicy {
  43     Base64DoNotValidatePadding,
  44     Base64ValidatePadding
  45 };
  46
  47 WTF_EXPORT void base64Encode(const char*, unsigned, Vector<char>&, Base64EncodePolicy = Base64DoNotInsertLFs);
  48 WTF_EXPORT void base64Encode(const Vector<char>&, Vector<char>&, Base64EncodePolicy = Base64DoNotInsertLFs);
  49 WTF_EXPORT void base64Encode(const CString&, Vector<char>&, Base64EncodePolicy = Base64DoNotInsertLFs);
  50 WTF_EXPORT String base64Encode(const char*, unsigned, Base64EncodePolicy = Base64DoNotInsertLFs);
  51 WTF_EXPORT String base64Encode(const Vector<char>&, Base64EncodePolicy = Base64DoNotInsertLFs);
  52 WTF_EXPORT String base64Encode(const CString&, Base64EncodePolicy = Base64DoNotInsertLFs);
  53
  54 WTF_EXPORT bool base64Decode(const String&, Vector<char>&, CharacterMatchFunctionPtr shouldIgnoreCharacter = 0, Base64DecodePolicy = Base64DoNotValidatePadding);
  55 WTF_EXPORT bool base64Decode(const Vector<char>&, Vector<char>&, CharacterMatchFunctionPtr shouldIgnoreCharacter = 0, Base64DecodePolicy = Base64DoNotValidatePadding);
  56 WTF_EXPORT bool base64Decode(const char*, unsigned, Vector<char>&, CharacterMatchFunctionPtr shouldIgnoreCharacter = 0, Base64DecodePolicy = Base64DoNotValidatePadding);
  57 WTF_EXPORT bool base64Decode(const UChar*, unsigned, Vector<char>&, CharacterMatchFunctionPtr shouldIgnoreCharacter = 0, Base64DecodePolicy = Base64DoNotValidatePadding);
  58
  59 // Given an encoding in either base64 or base64url, returns a normalized
  60 // encoding in plain base64.
  61 WTF_EXPORT String normalizeToBase64(const String&);
  62
  63 WTF_EXPORT String base64URLEncode(const char*, unsigned, Base64EncodePolicy = Base64DoNotInsertLFs);
  64
  65 inline void base64Encode(const Vector<char>& in, Vector<char>& out, Base64EncodePolicy policy)
  66 {
  67     base64Encode(in.data(), in.size(), out, policy);
  68 }
  69
  70 inline void base64Encode(const CString& in, Vector<char>& out, Base64EncodePolicy policy)
  71 {
  72     base64Encode(in.data(), in.length(), out, policy);
  73 }
  74
  75 inline String base64Encode(const Vector<char>& in, Base64EncodePolicy policy)
  76 {
  77     return base64Encode(in.data(), in.size(), policy);
  78 }
  79
  80 inline String base64Encode(const CString& in, Base64EncodePolicy policy)
  81 {
  82     return base64Encode(in.data(), in.length(), policy);
  83 }
  84
  85 } // namespace WTF
  86
  87 using WTF::Base64EncodePolicy;
  88 using WTF::Base64DoNotInsertLFs;
  89 using WTF::Base64InsertLFs;
  90 using WTF::Base64DecodePolicy;
  91 using WTF::Base64DoNotValidatePadding;
  92 using WTF::Base64ValidatePadding;
  93 using WTF::base64Encode;
  94 using WTF::base64Decode;
  95
  96 #endif // Base64_h