Home | History | Annotate | Download | only in text 
      1 /*
      2  * Copyright (C) 2006 Alexey Proskuryakov <ap (at) webkit.org>
      3  * Copyright (C) 2010 Patrick Gansterer <paroga (at) 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 Base64InvalidCharactersPolicy {
     43     Base64FailOnInvalidCharacter,
     44     Base64IgnoreWhitespace,
     45     Base64IgnoreInvalidCharacters
     46 };
     47 
     48 enum Base64PaddingValidationPolicy {
     49     Base64NoPaddingValidation,
     50     Base64StrictPaddingValidation
     51 };
     52 
     53 WTF_EXPORT void base64Encode(const char*, unsigned, Vector<char>&, Base64EncodePolicy = Base64DoNotInsertLFs);
     54 WTF_EXPORT void base64Encode(const Vector<char>&, Vector<char>&, Base64EncodePolicy = Base64DoNotInsertLFs);
     55 WTF_EXPORT void base64Encode(const CString&, Vector<char>&, Base64EncodePolicy = Base64DoNotInsertLFs);
     56 WTF_EXPORT String base64Encode(const char*, unsigned, Base64EncodePolicy = Base64DoNotInsertLFs);
     57 WTF_EXPORT String base64Encode(const Vector<char>&, Base64EncodePolicy = Base64DoNotInsertLFs);
     58 WTF_EXPORT String base64Encode(const CString&, Base64EncodePolicy = Base64DoNotInsertLFs);
     59 
     60 WTF_EXPORT bool base64Decode(const String&, Vector<char>&, Base64InvalidCharactersPolicy = Base64FailOnInvalidCharacter, Base64PaddingValidationPolicy = Base64NoPaddingValidation);
     61 WTF_EXPORT bool base64Decode(const Vector<char>&, Vector<char>&, Base64InvalidCharactersPolicy = Base64FailOnInvalidCharacter, Base64PaddingValidationPolicy = Base64NoPaddingValidation);
     62 WTF_EXPORT bool base64Decode(const char*, unsigned, Vector<char>&, Base64InvalidCharactersPolicy = Base64FailOnInvalidCharacter, Base64PaddingValidationPolicy = Base64NoPaddingValidation);
     63 
     64 inline void base64Encode(const Vector<char>& in, Vector<char>& out, Base64EncodePolicy policy)
     65 {
     66     base64Encode(in.data(), in.size(), out, policy);
     67 }
     68 
     69 inline void base64Encode(const CString& in, Vector<char>& out, Base64EncodePolicy policy)
     70 {
     71     base64Encode(in.data(), in.length(), out, policy);
     72 }
     73 
     74 inline String base64Encode(const Vector<char>& in, Base64EncodePolicy policy)
     75 {
     76     return base64Encode(in.data(), in.size(), policy);
     77 }
     78 
     79 inline String base64Encode(const CString& in, Base64EncodePolicy policy)
     80 {
     81     return base64Encode(in.data(), in.length(), policy);
     82 }
     83 
     84 } // namespace WTF
     85 
     86 using WTF::Base64EncodePolicy;
     87 using WTF::Base64DoNotInsertLFs;
     88 using WTF::Base64InsertLFs;
     89 using WTF::Base64InvalidCharactersPolicy;
     90 using WTF::Base64FailOnInvalidCharacter;
     91 using WTF::Base64IgnoreWhitespace;
     92 using WTF::Base64IgnoreInvalidCharacters;
     93 using WTF::Base64PaddingValidationPolicy;
     94 using WTF::Base64NoPaddingValidation;
     95 using WTF::Base64StrictPaddingValidation;
     96 using WTF::base64Encode;
     97 using WTF::base64Decode;
     98 
     99 #endif // Base64_h
    100