/usr/include/thunderbird/nsLinebreakConverter.h is in thunderbird-dev 1:52.8.0-1~deb8u1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsLinebreakConverter_h_
#define nsLinebreakConverter_h_
#include "nscore.h"
#include "nsString.h"
// utility class for converting between different line breaks.
class nsLinebreakConverter
{
public:
// Note: enum must match char* array in GetLinebreakString
typedef enum {
eLinebreakAny, // any kind of linebreak (i.e. "don't care" source)
eLinebreakPlatform, // platform linebreak
eLinebreakContent, // Content model linebreak (LF)
eLinebreakNet, // Form submission linebreak (CRLF)
eLinebreakMac, // CR
eLinebreakUnix, // LF
eLinebreakWindows, // CRLF
eLinebreakSpace // space characters. Only valid as destination type
} ELinebreakType;
enum {
kIgnoreLen = -1
};
/* ConvertLineBreaks
* Convert line breaks in the supplied string, allocating and returning
* a new buffer. Returns nullptr on failure.
* @param aSrc: the source string. if aSrcLen == kIgnoreLen this string is assumed
* to be null terminated, otherwise it must be at least aSrcLen long.
* @param aSrcBreaks: the line breaks in the source. If unknown, pass eLinebreakAny.
* If known, pass the known value, as this may be more efficient.
* @param aDestBreaks: the line breaks you want in the output.
* @param aSrcLen: length of the source. If -1, the source is assumed to be a null-
* terminated string.
* @param aOutLen: used to return character length of returned buffer, if not null.
*/
static char* ConvertLineBreaks(const char* aSrc,
ELinebreakType aSrcBreaks, ELinebreakType aDestBreaks,
int32_t aSrcLen = kIgnoreLen, int32_t* aOutLen = nullptr);
/* ConvertUnicharLineBreaks
* Convert line breaks in the supplied string, allocating and returning
* a new buffer. Returns nullptr on failure.
* @param aSrc: the source string. if aSrcLen == kIgnoreLen this string is assumed
* to be null terminated, otherwise it must be at least aSrcLen long.
* @param aSrcBreaks: the line breaks in the source. If unknown, pass eLinebreakAny.
* If known, pass the known value, as this may be more efficient.
* @param aDestBreaks: the line breaks you want in the output.
* @param aSrcLen: length of the source, in characters. If -1, the source is assumed to be a null-
* terminated string.
* @param aOutLen: used to return character length of returned buffer, if not null.
*/
static char16_t* ConvertUnicharLineBreaks(const char16_t* aSrc,
ELinebreakType aSrcBreaks, ELinebreakType aDestBreaks,
int32_t aSrcLen = kIgnoreLen, int32_t* aOutLen = nullptr);
/* ConvertStringLineBreaks
* Convert line breaks in the supplied string, changing the string buffer (i.e. in-place conversion)
* @param ioString: the string to be converted.
* @param aSrcBreaks: the line breaks in the source. If unknown, pass eLinebreakAny.
* If known, pass the known value, as this may be more efficient.
* @param aDestBreaks: the line breaks you want in the output.
* @param aSrcLen: length of the source, in characters. If -1, the source is assumed to be a null-
* terminated string.
*/
static nsresult ConvertStringLineBreaks(nsString& aIoString,
ELinebreakType aSrcBreaks,
ELinebreakType aDestBreaks);
/* ConvertLineBreaksInSitu
* Convert line breaks in place if possible. NOTE: THIS MAY REALLOCATE THE BUFFER,
* BUT IT WON'T FREE THE OLD BUFFER (because it doesn't know how). So be prepared
* to keep a copy of the old pointer, and free it if this passes back a new pointer.
* ALSO NOTE: DON'T PASS A STATIC STRING POINTER TO THIS FUNCTION.
*
* @param ioBuffer: the source buffer. if aSrcLen == kIgnoreLen this string is assumed
* to be null terminated, otherwise it must be at least aSrcLen long.
* @param aSrcBreaks: the line breaks in the source. If unknown, pass eLinebreakAny.
* If known, pass the known value, as this may be more efficient.
* @param aDestBreaks: the line breaks you want in the output.
* @param aSrcLen: length of the source. If -1, the source is assumed to be a null-
* terminated string.
* @param aOutLen: used to return character length of returned buffer, if not null.
*/
static nsresult ConvertLineBreaksInSitu(char** aIoBuffer,
ELinebreakType aSrcBreaks,
ELinebreakType aDestBreaks,
int32_t aSrcLen = kIgnoreLen,
int32_t* aOutLen = nullptr);
/* ConvertUnicharLineBreaksInSitu
* Convert line breaks in place if possible. NOTE: THIS MAY REALLOCATE THE BUFFER,
* BUT IT WON'T FREE THE OLD BUFFER (because it doesn't know how). So be prepared
* to keep a copy of the old pointer, and free it if this passes back a new pointer.
*
* @param ioBuffer: the source buffer. if aSrcLen == kIgnoreLen this string is assumed
* to be null terminated, otherwise it must be at least aSrcLen long.
* @param aSrcBreaks: the line breaks in the source. If unknown, pass eLinebreakAny.
* If known, pass the known value, as this may be more efficient.
* @param aDestBreaks: the line breaks you want in the output.
* @param aSrcLen: length of the source in characters. If -1, the source is assumed to be a null-
* terminated string.
* @param aOutLen: used to return character length of returned buffer, if not null.
*/
static nsresult ConvertUnicharLineBreaksInSitu(char16_t** aIoBuffer,
ELinebreakType aSrcBreaks,
ELinebreakType aDestBreaks,
int32_t aSrcLen = kIgnoreLen,
int32_t* aOutLen = nullptr);
};
#endif // nsLinebreakConverter_h_
|