PDString.h

Go to the documentation of this file.

//
// PDString.h
//
// Copyright (c) 2012 - 2015 Karl-Johan Alm (http://github.com/kallewoof)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//

#ifndef INCLUDED_PDSTRING_H
#define INCLUDED_PDSTRING_H

#include "PDDefines.h"

extern PDStringRef PDStringCreate(char *string);

extern PDStringRef PDStringCreateUnescaped(char *unescapedString);

extern PDStringRef PDStringCreateWithName(char *name);

extern PDStringRef PDStringCreateBinary(char *data, PDSize length);

extern PDStringRef PDStringCreateWithHexString(char *hex);

extern PDStringRef PDStringCreateFromStringWithType(PDStringRef string, PDStringType type, PDBool wrap, PDBool requireCopy);

extern PDStringRef PDStringCreateUTF8Encoded(PDStringRef string);

extern PDStringRef PDStringCreateUTF16Encoded(PDStringRef string);

extern PDStringRef PDStringCopy(PDStringRef string);

extern PDStringEncoding PDStringEncodingGetByName(const char *encodingName);

extern void PDStringSetEncoding(PDStringRef string, PDStringEncoding encoding);

extern void PDStringSetFont(PDStringRef string, PDFontRef font);

extern void PDStringForceWrappedState(PDStringRef string, PDBool wrapped);

#define PDStringCreateBinaryFromString(string) PDStringCreateFromStringWithType(string, PDStringTypeBinary, false, false)

//#define PDStringWithUnescapedCString(unescapedCString) PDAutorelease(PDStringCreateBinary(unescapedCString, strlen(unescapedCString)))

#define PDStringEscapingCString(unescapedCString) PDAutorelease(PDStringCreateUnescaped(unescapedCString))

#define PDStringWithCString(cString) PDAutorelease(PDStringCreate(cString))

#define PDStringWithName(name) PDAutorelease(PDStringCreateWithName(name))

extern const char *PDStringEscapedValue(PDStringRef string, PDBool wrap);

extern const char *PDStringNameValue(PDStringRef string, PDBool wrap);

extern const char *PDStringBinaryValue(PDStringRef string, PDSize *outLength);

extern const char *PDStringHexValue(PDStringRef string, PDBool wrap);

extern PDBool PDStringEqualsCString(PDStringRef string, const char *cString);

extern PDBool PDStringEqualsString(PDStringRef string, PDStringRef string2);

extern PDBool PDStringIsWrapped(PDStringRef string);

extern PDStringType PDStringGetType(PDStringRef string);

extern PDStringEncoding PDStringGetEncoding(PDStringRef string);

#ifdef PD_SUPPORT_CRYPTO

extern PDBool PDStringIsEncrypted(PDStringRef string);

extern void PDStringAttachCrypto(PDStringRef string, pd_crypto crypto, PDInteger objectID, PDInteger genNumber, PDBool encrypted);

extern PDStringRef PDStringCreateEncrypted(PDStringRef string);

extern PDStringRef PDStringCreateDecrypted(PDStringRef string);

extern PDDictionaryRef PDStringLatinCharsetDict(void);

extern const char **PDStringLatinRCharsetArray(void);

extern const unsigned char PDStringLatinPDFToWin[];

extern PDInteger PDStringPrinter(void *inst, char **buf, PDInteger offs, PDInteger *cap);

#endif // PD_SUPPORT_CRYPTO

#endif // INCLUDED_PDSTRING_H