2006-01-16 22:02:54 +01:00
|
|
|
// Copyright (c) 2005, Niels Martin Hansen
|
|
|
|
// All rights reserved.
|
|
|
|
//
|
|
|
|
// Redistribution and use in source and binary forms, with or without
|
|
|
|
// modification, are permitted provided that the following conditions are met:
|
|
|
|
//
|
|
|
|
// * Redistributions of source code must retain the above copyright notice,
|
|
|
|
// this list of conditions and the following disclaimer.
|
|
|
|
// * Redistributions in binary form must reproduce the above copyright notice,
|
|
|
|
// this list of conditions and the following disclaimer in the documentation
|
|
|
|
// and/or other materials provided with the distribution.
|
|
|
|
// * Neither the name of the Aegisub Group nor the names of its contributors
|
|
|
|
// may be used to endorse or promote products derived from this software
|
|
|
|
// without specific prior written permission.
|
|
|
|
//
|
|
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
|
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
|
|
|
|
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
|
|
|
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
|
|
|
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
//
|
2009-07-29 07:43:02 +02:00
|
|
|
// Aegisub Project http://www.aegisub.org/
|
2006-01-16 22:02:54 +01:00
|
|
|
//
|
2009-07-29 07:43:02 +02:00
|
|
|
// $Id$
|
2006-01-16 22:02:54 +01:00
|
|
|
|
2009-07-29 07:43:02 +02:00
|
|
|
/// @file string_codec.h
|
|
|
|
/// @see string_codec.cpp
|
|
|
|
/// @ingroup utility
|
|
|
|
///
|
|
|
|
/// Functions for "inline string encoding" handling,
|
|
|
|
/// a simple encoding-form used for encoding strings that can't contain control codes and a few other special characters,
|
|
|
|
/// so they can be stored as part of a field in an ASS line
|
|
|
|
///
|
|
|
|
/// Even though the encoding will handle unicode strings, it can only encode ASCII characters.
|
|
|
|
/// This is not a problem, since only ASCII characters are used for the special purposes.
|
|
|
|
///
|
|
|
|
/// The encoding is based on an escape-character followed by a two-digit hexadecimal number, the number being the
|
|
|
|
/// ASCII code for the encoded character. The escape character is # (ASCII 0x23).
|
|
|
|
///
|
2009-07-30 05:36:53 +02:00
|
|
|
/// @verbatim
|
2009-07-29 07:43:02 +02:00
|
|
|
/// The following ASCII codes must be escaped:
|
|
|
|
/// 0x00 .. 0x1F -- Control codes (nonprintable characters, including linebreaks)
|
|
|
|
/// 0x23 -- Sharp (the escape character itself must be escaped to appear in the literal)
|
|
|
|
/// 0x2C -- Comma (used for field separator in standard ASS lines)
|
|
|
|
/// 0x3A -- Colon (used in some custom list formats for name:value pairs)
|
|
|
|
/// 0x7C -- Pipe (used in some custom lists, as item separator, eg. itemA|itemB)
|
2009-07-30 05:36:53 +02:00
|
|
|
/// @endverbatim
|
2009-07-29 07:43:02 +02:00
|
|
|
///
|
|
|
|
/// The encoded string should be usable in any kind of field in an ASS file.
|
2006-01-16 22:02:54 +01:00
|
|
|
|
|
|
|
#ifndef _STRING_CODEC_H
|
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
|
|
|
|
|
|
|
/// DOCME
|
2006-01-16 22:02:54 +01:00
|
|
|
#define _STRING_CODEC_H
|
|
|
|
|
|
|
|
#include <wx/string.h>
|
|
|
|
|
2007-04-04 02:01:17 +02:00
|
|
|
wxString inline_string_encode(const wxString &input);
|
|
|
|
wxString inline_string_decode(const wxString &input);
|
2006-01-16 22:02:54 +01:00
|
|
|
|
|
|
|
#endif
|
2009-07-29 07:43:02 +02:00
|
|
|
|
Note: This was done using a script! it's far from perfect but 95% of the work has been done already formatting-wise.
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there.
This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style.
Some notes:
* Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those.
* Some multiline comments may have been munged into single line comments
* Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them.
* Enum comments can go after the enumeration itself '[value] /// comment'
* include/aegisub/*.h haven't been converted yet, this will be done in a later commit
* Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa.
See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'.
Originally committed to SVN as r3312.
2009-07-30 00:59:22 +02:00
|
|
|
|