mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-19 18:45:52 +00:00
81 lines
2.9 KiB
C++
81 lines
2.9 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of Beast: https://github.com/vinniefalco/Beast
|
|
Copyright 2013, Vinnie Falco <vinnie.falco@gmail.com>
|
|
|
|
Portions of this file are from JUCE.
|
|
Copyright (c) 2013 - Raw Material Software Ltd.
|
|
Please visit http://www.juce.com
|
|
|
|
Permission to use, copy, modify, and/or distribute this software for any
|
|
purpose with or without fee is hereby granted, provided that the above
|
|
copyright notice and this permission notice appear in all copies.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|
|
//==============================================================================
|
|
|
|
#ifndef BEAST_STRINGS_NEWLINE_H_INCLUDED
|
|
#define BEAST_STRINGS_NEWLINE_H_INCLUDED
|
|
|
|
#include "../Config.h"
|
|
|
|
#include "String.h"
|
|
|
|
namespace beast {
|
|
|
|
//==============================================================================
|
|
/** This class is used for represent a new-line character sequence.
|
|
|
|
To write a new-line to a stream, you can use the predefined 'newLine' variable, e.g.
|
|
@code
|
|
myOutputStream << "Hello World" << newLine << newLine;
|
|
@endcode
|
|
|
|
The exact character sequence that will be used for the new-line can be set and
|
|
retrieved with OutputStream::setNewLineString() and OutputStream::getNewLineString().
|
|
*/
|
|
class BEAST_API NewLine
|
|
{
|
|
public:
|
|
/** Returns the default new-line sequence that the library uses.
|
|
@see OutputStream::setNewLineString()
|
|
*/
|
|
static const char* getDefault() noexcept { return "\r\n"; }
|
|
|
|
/** Returns the default new-line sequence that the library uses.
|
|
@see getDefault()
|
|
*/
|
|
operator String() const { return getDefault(); }
|
|
};
|
|
|
|
//==============================================================================
|
|
/** A predefined object representing a new-line, which can be written to a string or stream.
|
|
|
|
To write a new-line to a stream, you can use the predefined 'newLine' variable like this:
|
|
@code
|
|
myOutputStream << "Hello World" << newLine << newLine;
|
|
@endcode
|
|
*/
|
|
extern NewLine newLine;
|
|
|
|
//==============================================================================
|
|
/** Writes a new-line sequence to a string.
|
|
You can use the predefined object 'newLine' to invoke this, e.g.
|
|
@code
|
|
myString << "Hello World" << newLine << newLine;
|
|
@endcode
|
|
*/
|
|
BEAST_API String& BEAST_CALLTYPE operator<< (String& string1, const NewLine&);
|
|
|
|
}
|
|
|
|
#endif
|
|
|