mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-08 20:47:44 +00:00
159 lines
7.4 KiB
C++
159 lines
7.4 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#ifndef nsLinebreakConverter_h_
|
|
#define nsLinebreakConverter_h_
|
|
|
|
|
|
#include "nscore.h"
|
|
#include "nsString.h"
|
|
|
|
// utility class for converting between different line breaks.
|
|
|
|
class NS_COM 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 nsnull 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,
|
|
PRInt32 aSrcLen = kIgnoreLen, PRInt32* aOutLen = nsnull);
|
|
|
|
|
|
/* ConvertUnicharLineBreaks
|
|
* Convert line breaks in the supplied string, allocating and returning
|
|
* a new buffer. Returns nsnull 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 PRUnichar* ConvertUnicharLineBreaks(const PRUnichar* aSrc,
|
|
ELinebreakType aSrcBreaks, ELinebreakType aDestBreaks,
|
|
PRInt32 aSrcLen = kIgnoreLen, PRInt32* aOutLen = nsnull);
|
|
|
|
|
|
/* 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& ioString, 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 **ioBuffer, ELinebreakType aSrcBreaks, ELinebreakType aDestBreaks,
|
|
PRInt32 aSrcLen = kIgnoreLen, PRInt32* aOutLen = nsnull);
|
|
|
|
|
|
/* 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(PRUnichar **ioBuffer, ELinebreakType aSrcBreaks, ELinebreakType aDestBreaks,
|
|
PRInt32 aSrcLen = kIgnoreLen, PRInt32* aOutLen = nsnull);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
#endif // nsLinebreakConverter_h_
|