iqbalrifai
/
Aegisub
mirror of https://github.com/odrling/Aegisub
1
0
Fork 0
Code Issues Releases Wiki Activity
Aegisub/aegisub/src/ass_override.cpp

840 lines
26 KiB
C++
Raw Normal View History

Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// Copyright (c) 2005, Rodrigo Braz Monteiro
// 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.
//
Switch all headers to using Doxygen and cleanup contact info * Swap old email + website address with 'Aegisub Project http://www.aegisub.org/' * Set categories for all files (jfs) * Add descriptions for each file (jfs) * Add $Id$ keyword Originally committed to SVN as r3310.
2009-07-29 07:43:02 +02:00
// Aegisub Project http://www.aegisub.org/
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
//
Switch all headers to using Doxygen and cleanup contact info * Swap old email + website address with 'Aegisub Project http://www.aegisub.org/' * Set categories for all files (jfs) * Add descriptions for each file (jfs) * Add $Id$ keyword Originally committed to SVN as r3310.
2009-07-29 07:43:02 +02:00
// $Id$
/// @file ass_override.cpp
/// @brief Parse and modify ASSA style overrides
/// @ingroup subs_storage
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
////////////
// Includes
Change how configuration works. * move win32/config0.h -> config/config_windows0.h * move win32/stdint.h -> msvc/stdint.h * move posix/defines.h -> config/config_unix.h * add config.h - brings in config_(windows|unix).h as required * add config.h to *.cpp * Self-contain FFmpegSource2 with required function defines wrapped with __UNIX__ instead of the now removed defines.h. * Edit aegisub_vs2008.vcproj to remove explicit inclusion of config.h, also change VCPreBuildEventTool to create windows_config.h from windows_config0.h. Add msvc to include path. * Change configure to create ./acconf.h instead of posix/acconf.h This will allow us to create a more standard and platform agnostic way of configuration aegsisub during build time. Originally committed to SVN as r2621.
2009-01-04 07:31:48 +01:00
#include "config.h"
Fix all the headers in *.cpp, this includes: * Wrapping all headers that are in agi_pre.h with AGI_PRE. * Sorting alphabetically. Originally committed to SVN as r3515.
2009-09-10 15:06:40 +02:00
#ifndef AGI_PRE
jfs's mac patches applied Originally committed to SVN as r1560.
2007-09-12 01:22:26 +02:00
#include <wx/log.h>
Fix all the headers in *.cpp, this includes: * Wrapping all headers that are in agi_pre.h with AGI_PRE. * Sorting alphabetically. Originally committed to SVN as r3515.
2009-09-10 15:06:40 +02:00
#include <wx/tokenzr.h>
#endif
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
Fix all the headers in *.cpp, this includes: * Wrapping all headers that are in agi_pre.h with AGI_PRE. * Sorting alphabetically. Originally committed to SVN as r3515.
2009-09-10 15:06:40 +02:00
#include "ass_dialogue.h"
#include "ass_override.h"
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01: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
/// @brief Constructor AssOverrideParameter //////////////////////
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideParameter::AssOverrideParameter () {
classification = PARCLASS_NORMAL;
ommited = false;
}
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
/// @brief Destructor
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideParameter::~AssOverrideParameter () {
Merged opengl branch from 806 to 859 Originally committed to SVN as r860.
2007-01-21 07:30:19 +01:00
DeleteValue();
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01: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
/// @brief Copy
/// @param param
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
void AssOverrideParameter::CopyFrom (const AssOverrideParameter &param) {
switch(param.GetType()) {
case VARDATA_INT: SetInt(param.AsInt()); break;
case VARDATA_FLOAT: SetFloat(param.AsFloat()); break;
case VARDATA_TEXT: SetText(param.AsText()); break;
case VARDATA_BOOL: SetBool(param.AsBool()); break;
case VARDATA_COLOUR: SetColour(param.AsColour()); break;
case VARDATA_BLOCK: SetBlock(param.AsBlock()); break;
default: DeleteValue();
}
classification = param.classification;
ommited = param.ommited;
}
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
/// @brief DOCME
/// @param param
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
void AssOverrideParameter::operator= (const AssOverrideParameter &param) {
CopyFrom(param);
}
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
/// @brief Constructor AssDialogueBlockOverride //////////////////////
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssDialogueBlockOverride::AssDialogueBlockOverride () {
}
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
/// @brief Destructor
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssDialogueBlockOverride::~AssDialogueBlockOverride () {
Fixed some minor memory leaks, and failed to fix another. Originally committed to SVN as r796.
2007-01-15 07:56:35 +01:00
for (size_t i=0;i<Tags.size();i++) {
delete Tags[i];
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
}
Tags.clear();
}
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
/// @brief Read tags
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
void AssDialogueBlockOverride::ParseTags () {
// Clear current vector
Fixed some minor memory leaks, and failed to fix another. Originally committed to SVN as r796.
2007-01-15 07:56:35 +01:00
for (size_t i=0;i<Tags.size();i++) {
delete Tags[i];
}
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
Tags.clear();
// Fix parenthesis matching
while (text.Freq(_T('(')) > text.Freq(_T(')'))) {
text += _T(")");
}
// Initialize tokenizer
wxStringTokenizer tkn(text,_T("\\"),wxTOKEN_RET_EMPTY_ALL);
Don't assume override blocks always start with a backslash, since many people use them for comments Originally committed to SVN as r1202.
2007-06-03 02:37:49 +02:00
wxString curTag;
if (text.StartsWith(_T("\\"))) curTag = _T("\\");
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
while (tkn.HasMoreTokens()) {
Don't assume override blocks always start with a backslash, since many people use them for comments Originally committed to SVN as r1202.
2007-06-03 02:37:49 +02:00
//curTag will always start with a backslash after first loop - see end of loop
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
curTag += tkn.GetNextToken();
if (curTag == _T("\\")) continue;
// Check for parenthesis matching
while (curTag.Freq(_T('(')) > curTag.Freq(_T(')'))) {
if (!tkn.HasMoreTokens()) {
wxLogWarning(_T("Unmatched parenthesis! Line contents: ") + parent->Text);
break;
}
curTag << _T("\\") << tkn.GetNextToken();
}
AssOverrideTag *newTag = new AssOverrideTag;
newTag->SetText(curTag);
Tags.push_back(newTag);
Don't assume override blocks always start with a backslash, since many people use them for comments Originally committed to SVN as r1202.
2007-06-03 02:37:49 +02:00
curTag = _T("\\");
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01: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
/// @brief Get Text representation
/// @return
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
wxString AssDialogueBlockOverride::GetText () {
text = _T("");
for (std::vector<AssOverrideTag*>::iterator cur=Tags.begin();cur!=Tags.end();cur++) {
text += (*cur)->ToString();
}
return text;
}
Make a typedef of a function type, hoping to fix Doxygen warnings. Originally committed to SVN as r3348.
2009-08-01 05:27:13 +02:00
void AssDialogueBlockOverride::ProcessParameters(AssDialogueBlockOverride::ProcessParametersCallback callback,void *userData) {
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideTag *curTag;
AssOverrideParameter *curPar;
// Find tags
for (std::vector<AssOverrideTag*>::iterator cur=Tags.begin();cur!=Tags.end();cur++) {
int n = 0;
curTag = *cur;
// Find parameters
for (std::vector<AssOverrideParameter*>::iterator curParam=curTag->Params.begin();curParam!=curTag->Params.end();curParam++) {
curPar = *curParam;
if (curPar->GetType() != VARDATA_NONE && curPar->ommited == false) {
// Do callback
(*callback)(curTag->Name,n,curPar,userData);
// Go recursive if it's a block parameter
//if (curPar->classification == VARDATA_BLOCK) {
if (curPar->GetType() == VARDATA_BLOCK) {
curPar->AsBlock()->ProcessParameters(callback,userData);
}
}
n++;
}
}
}
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
/// @brief Constructor AssOverrideParamProto //////////////////////////
/// @param _type
/// @param opt
/// @param classi
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideParamProto::AssOverrideParamProto (VariableDataType _type,int opt,ASS_ParameterClass classi) {
type = _type;
optional = opt;
classification = classi;
}
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
/// @brief Destructor
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideParamProto::~AssOverrideParamProto() {
}
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
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
std::list<AssOverrideTagProto> AssOverrideTagProto::proto;
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
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
bool AssOverrideTagProto::loaded = false;
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
/// @brief Constructor
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideTagProto::AssOverrideTagProto() {
}
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
/// @brief Destructor
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideTagProto::~AssOverrideTagProto() {
}
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
/// @brief Load prototypes
/// @return
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
void AssOverrideTagProto::LoadProtos () {
if (loaded) return;
loaded = true;
// \alpha
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\alpha");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT));
// \bord<depth>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\bord");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_SIZE));
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
// \xbord<depth>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\xbord");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_SIZE));
// \ybord<depth>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\ybord");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_SIZE));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// \shad<depth>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\shad");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_SIZE));
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
// \xshad<depth>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\xshad");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_SIZE));
// \yshad<depth>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\yshad");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_SIZE));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// \fade(<a1>,<a2>,<a3>,<t1>,<t2>,<t3>,<t4>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fade");
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_RELATIVE_TIME_START));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_RELATIVE_TIME_START));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_RELATIVE_TIME_START));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_RELATIVE_TIME_START));
// \move(<x1>,<y1>,<x2>,<y2>[,<t1>,<t2>])
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\move");
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_X));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_X));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,OPTIONAL_6,PARCLASS_RELATIVE_TIME_START));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,OPTIONAL_6,PARCLASS_RELATIVE_TIME_START));
// \clip(<x1>,<y1>,<x2>,<y2>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\clip");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_X));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_X));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
// \clip([<scale>,]<some drawings>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\clip");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,OPTIONAL_2,PARCLASS_NORMAL));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_DRAWING));
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
// \iclip(<x1>,<y1>,<x2>,<y2>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\iclip");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_X));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_X));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
// \iclip([<scale>,]<some drawings>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\iclip");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,OPTIONAL_2,PARCLASS_NORMAL));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_DRAWING));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// \fscx<percent>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fscx");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_RELATIVE_SIZE_X));
// \fscy<percent>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fscy");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_RELATIVE_SIZE_Y));
// \pos(<x>,<y>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\pos");
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_X));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// \org(<x>,<y>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\org");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_X));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
// \pbo<y>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\pbo");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_POS_Y));
// \fad(<t1>,<t2>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fad");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_RELATIVE_TIME_START));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_RELATIVE_TIME_END));
// \fsp<pixels>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fsp");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_SIZE));
// \frx<degrees>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\frx");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \fry<degrees>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fry");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \frz<degrees>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\frz");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \fr<degrees>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fr");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_NORMAL));
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
// \fax<factor>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fax");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \fay<factor>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fay");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_NORMAL));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// \1c&H<bbggrr>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\1c");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \2c&H<bbggrr>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\2c");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \3c&H<bbggrr>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\3c");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \4c&H<bbggrr>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\4c");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \1a&H<aa>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\1a");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \2a&H<aa>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\2a");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \3a&H<aa>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\3a");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \4a&H<aa>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\4a");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \fe<charset>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fe");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \ko<duration>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\ko");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_KARAOKE));
// \kf<duration>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\kf");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_KARAOKE));
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
// \be<strength>
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\be");
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \blur<strength>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\blur");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_NORMAL));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// \fn<name>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fn");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \fs<size>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\fs");
Made style's font size, scale x and scale y floats. Also made \fs take float as parameter. Originally committed to SVN as r304.
2006-04-04 22:41:09 +02:00
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,NOT_OPTIONAL,PARCLASS_ABSOLUTE_SIZE));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// \an<alignment>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\an");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \c&H<bbggrr>&
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\c");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \b<0/1/weight>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\b");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,OPTIONAL_1,PARCLASS_NORMAL));
proto.back().params.back().defaultValue.SetBool(false);
// \i<0/1>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\i");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_BOOL,OPTIONAL_1,PARCLASS_NORMAL));
proto.back().params.back().defaultValue.SetBool(false);
// \u<0/1>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\u");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_BOOL,OPTIONAL_1,PARCLASS_NORMAL));
proto.back().params.back().defaultValue.SetBool(false);
// \s<0/1>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\s");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_BOOL,OPTIONAL_1,PARCLASS_NORMAL));
proto.back().params.back().defaultValue.SetBool(false);
// \a<alignment>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\a");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \k<duration>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\k");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_KARAOKE));
// \K<duration>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\K");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_KARAOKE));
// \q<0-3>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\q");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \p<n>
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\p");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,NOT_OPTIONAL,PARCLASS_NORMAL));
// \r[<name>]
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\r");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_TEXT,OPTIONAL_1,PARCLASS_NORMAL));
// \t([<t1>,<t2>,][<accel>,]<style modifiers>)
proto.push_back(AssOverrideTagProto());
proto.back().name = _T("\\t");
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,OPTIONAL_3 | OPTIONAL_4,PARCLASS_RELATIVE_TIME_START));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_INT,OPTIONAL_3 | OPTIONAL_4,PARCLASS_RELATIVE_TIME_START));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_FLOAT,OPTIONAL_2 | OPTIONAL_4,PARCLASS_NORMAL));
proto.back().params.push_back(AssOverrideParamProto(VARDATA_BLOCK,NOT_OPTIONAL,PARCLASS_NORMAL));
}
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
/// @brief Constructor AssOverrideTag //////////////////////////
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideTag::AssOverrideTag () {
valid = false;
}
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
/// @brief Destructor
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideTag::~AssOverrideTag () {
Fixed some minor memory leaks, and failed to fix another. Originally committed to SVN as r796.
2007-01-15 07:56:35 +01:00
Clear();
}
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
/// @brief Clear
///
Fixed some minor memory leaks, and failed to fix another. Originally committed to SVN as r796.
2007-01-15 07:56:35 +01:00
void AssOverrideTag::Clear() {
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
for (std::vector<AssOverrideParameter*>::iterator cur=Params.begin();cur!=Params.end();cur++) {
delete *cur;
}
Params.clear();
valid = false;
}
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
/// @brief Parses text and sets tag
/// @param text
///
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
void AssOverrideTag::SetText (const wxString &text) {
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// Determine name
Name = _T("");
AssOverrideTagProto *proto;
for (std::list<AssOverrideTagProto>::iterator cur=AssOverrideTagProto::proto.begin();cur!=AssOverrideTagProto::proto.end();cur++) {
proto = &(*cur);
if (text.Left(proto->name.length()) == proto->name) {
Name = proto->name;
break;
}
}
// Set tag name
if (!Name.empty()) {
ParseParameters(text.Mid(Name.length()));
valid = true;
}
// Junk tag
else {
Name = text;
valid = false;
}
}
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
/// @brief Checks if it is valid
/// @return
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
bool AssOverrideTag::IsValid() {
return valid;
}
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
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
/// @brief Parses the parameters for the ass override tag
/// @param text All text between the name and the next \ or the end of the override block
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
///
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
void AssOverrideTag::ParseParameters(const wxString &text) {
Fixed some minor memory leaks, and failed to fix another. Originally committed to SVN as r796.
2007-01-15 07:56:35 +01:00
// Clear first
Clear();
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
// Tokenize text, attempting to find all parameters
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
wxArrayString paramList;
wxString work;
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
{
if (text.IsEmpty() || text[0] != _T('(')) {
// There's just one (or none at all) parameter (because there's no parantheses)
// This means text is all our parameters
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
wxString param(text);
paramList.Add(param.Trim(true).Trim(false));
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
// Only using goto here to avoid yet another nested block (keeps the code cleaner!)
goto end_tokenizing;
}
// Ok, so there are parantheses used here, so there may be more than one parameter
// Enter fullscale parsing!
size_t i = 0, textlen = text.Length();
size_t start = 0;
int parDepth = 1;
while (i < textlen && parDepth > 0) {
// Just skip until next ',' or ')', whichever comes first
// (Next ')' is achieved when parDepth == 0)
start = ++i;
while (i < textlen && parDepth > 0) {
if (text[i] == _T('(')) parDepth++;
if (text[i] == _T(')')) parDepth--;
// parDepth 1 is where we start, and the tag-level we're interested in parsing on
if (text[i] == _T(',') && parDepth == 1) break;
if (parDepth < 0) {
wxString::c_str() for varargs AGAIN Originally committed to SVN as r177.
2006-02-26 03:51:18 +01:00
wxLogWarning(_T("Unmatched parenthesis near '%s'!\nTag-parsing incomplete."), text.SubString(i, 10).c_str());
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
goto end_tokenizing;
}
if (parDepth == 0) {
// We just ate the paranthesis ending this parameter block
// Make sure it doesn't get included in the parameter text
break;
}
i++;
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
}
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
// i now points to the first character not member of this parameter
work = text.SubString(start, i-1);
work.Trim(true).Trim(false);
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
paramList.Add(work);
Fixed some minor memory leaks, and failed to fix another. Originally committed to SVN as r796.
2007-01-15 07:56:35 +01:00
//wxLogDebug(_T("Got parameter: %s"), work.c_str());
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
}
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
if (i+1 < textlen) {
// There's some additional garbage after the parantheses
// Just add it in for completeness
paramList.Add(text.Mid(i+1));
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
}
}
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
// This label is only gone to from inside the previous block, if the tokenizing needs to end early
end_tokenizing:
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
int curPar = 0;
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
size_t totalPars = paramList.GetCount();
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// Get optional parameters flag
ASS_ParameterOptional parsFlag = OPTIONAL_0;
switch (totalPars) {
case 1: parsFlag = OPTIONAL_1; break;
case 2: parsFlag = OPTIONAL_2; break;
case 3: parsFlag = OPTIONAL_3; break;
case 4: parsFlag = OPTIONAL_4; break;
case 5: parsFlag = OPTIONAL_5; break;
case 6: parsFlag = OPTIONAL_6; break;
case 7: parsFlag = OPTIONAL_7; break;
}
// Find prototype
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
bool clipOnce = true, iclipOnce = true;
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
AssOverrideTagProto *proto = NULL;
for (std::list<AssOverrideTagProto>::iterator cur=AssOverrideTagProto::proto.begin();cur!=AssOverrideTagProto::proto.end();cur++) {
if (Name == (*cur).name) {
if (Name == _T("\\clip") && totalPars != 4 && clipOnce) {
clipOnce = false;
continue;
}
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
if (Name == _T("\\iclip") && totalPars != 4 && iclipOnce) {
iclipOnce = false;
continue;
}
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
proto = &(*cur);
break;
}
}
if (proto == NULL) {
throw _T("Couldn't find tag prototype while parsing.");
}
// Get parameters
size_t n=0;
wxString curtok = _T("");
AssTime changed to store data as miliseconds internally (overall faster, uses less ram) Originally committed to SVN as r100.
2006-02-21 23:09:15 +01:00
if (curPar < (signed)totalPars) {
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
curtok = paramList[curPar];
curPar++;
}
Fixed parser to handle unset parameters properly (that is, without crashing) Originally committed to SVN as r6.
2006-01-17 08:52:18 +01:00
// For each parameter
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
while (n < proto->params.size()) {
AssOverrideParamProto *curproto = &proto->params[n];
bool isDefault = false;
n++;
// Create parameter
AssOverrideParameter *newparam = new AssOverrideParameter;
// Check if it's optional and not set (set to default)
if (!(curproto->optional & parsFlag)) {
Fixed parser to handle unset parameters properly (that is, without crashing) Originally committed to SVN as r6.
2006-01-17 08:52:18 +01:00
if (curproto->defaultValue.GetType() != VARDATA_NONE) {
isDefault = true;
newparam->CopyFrom(curproto->defaultValue);
}
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
newparam->ommited = true;
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
// This parameter doesn't really count against the number of parsed parameters,
// since it's left out. Don't count it.
curPar--;
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
}
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
if (isDefault == false && curtok.length() > 0) {
Fixed tag transformation with Lua expressions (%), issue #637 Originally committed to SVN as r1769.
2008-01-18 23:27:42 +01:00
wxChar firstChar = curtok[0];
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
bool auto4 = (firstChar == _T('!') || firstChar == _T('$') || firstChar == _T('%')) && curproto->type != VARDATA_BLOCK;
if (auto4) {
newparam->SetText(curtok);
}
else {
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
// Determine parameter type and set value
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
switch (curproto->type) {
case VARDATA_INT: {
Applied Mosc's patch (plus a small change to variable_data.cpp) to fix #605 and #557, both related to $ variables in the middle of tags being wiped by different features. Originally committed to SVN as r1698.
2008-01-13 20:36:05 +01:00
long temp = 0;
curtok.ToLong(&temp);
newparam->SetInt(temp);
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
break;
Applied Mosc's patch (plus a small change to variable_data.cpp) to fix #605 and #557, both related to $ variables in the middle of tags being wiped by different features. Originally committed to SVN as r1698.
2008-01-13 20:36:05 +01:00
}
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
case VARDATA_FLOAT: {
Applied Mosc's patch (plus a small change to variable_data.cpp) to fix #605 and #557, both related to $ variables in the middle of tags being wiped by different features. Originally committed to SVN as r1698.
2008-01-13 20:36:05 +01:00
double temp = 0.0;
curtok.ToDouble(&temp);
newparam->SetFloat(temp);
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
break;
Applied Mosc's patch (plus a small change to variable_data.cpp) to fix #605 and #557, both related to $ variables in the middle of tags being wiped by different features. Originally committed to SVN as r1698.
2008-01-13 20:36:05 +01:00
}
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
case VARDATA_TEXT:
newparam->SetText(curtok);
break;
case VARDATA_BOOL: {
Applied Mosc's patch (plus a small change to variable_data.cpp) to fix #605 and #557, both related to $ variables in the middle of tags being wiped by different features. Originally committed to SVN as r1698.
2008-01-13 20:36:05 +01:00
long temp = false;
curtok.ToLong(&temp);
newparam->SetBool(temp != 0);
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
break;
Applied Mosc's patch (plus a small change to variable_data.cpp) to fix #605 and #557, both related to $ variables in the middle of tags being wiped by different features. Originally committed to SVN as r1698.
2008-01-13 20:36:05 +01:00
}
Fix an assertion failure that happened whenever an ass override tag with too few parameters was parsed. Originally committed to SVN as r3340.
2009-08-01 01:26:13 +02:00
case VARDATA_BLOCK: {
AssDialogueBlockOverride *temp = new AssDialogueBlockOverride;
temp->text = curtok;
temp->ParseTags();
newparam->SetBlock(temp);
break;
}
default:
break;
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
}
}
// Get next actual parameter
AssTime changed to store data as miliseconds internally (overall faster, uses less ram) Originally committed to SVN as r100.
2006-02-21 23:09:15 +01:00
if (curPar < (signed)totalPars) {
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
// Unless this parameter was omitted (in which case the token shouldn't be eaten)
if (!newparam->ommited) {
curtok = paramList[curPar];
}
Really fixed the \t bug now. Really! Originally committed to SVN as r53.
2006-02-01 00:44:10 +01:00
curPar++;
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
}
else curtok = _T("");
}
// Add to list
newparam->classification = curproto->classification;
Params.push_back(newparam);
}
}
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
/// @brief Get string
///
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
wxString AssOverrideTag::ToString() {
// Start with name
wxString result = Name;
First three parameters to \fade() are now int as they should be Fixed \t argument disappearance bug! Originally committed to SVN as r48.
2006-01-29 23:46:18 +01:00
// Determine if it needs parentheses
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
bool parenthesis = false;
Add support for new override tags: \iclip \fax \fay \xshad \yshad \xbord \ybord \blur Support redefined override tags: \move (float-pos) \pos (float-pos) \be (variable) Make visual typesetting understand inverse clips and edit them correctly. Make vector clip visual tool able to convert a rectangular clip to a vector clip. What's missing: Proper rendering of inverse vector clips in visual tool overlay. Originally committed to SVN as r2336.
2008-09-10 18:13:54 +02:00
if (Name == _T("\\t") ||
Name == _T("\\pos") ||
Name == _T("\\fad") ||
Name == _T("\\org") ||
Name == _T("\\clip") ||
Name == _T("\\iclip") ||
Name == _T("\\move") ||
Name == _T("\\fade")) parenthesis = true;
Originally committed to SVN as r2.
2006-01-16 22:02:54 +01:00
if (parenthesis) result += _T("(");
// Add parameters
int n = 0;
for (std::vector<AssOverrideParameter*>::iterator cur=Params.begin();cur!=Params.end();cur++) {
if ((*cur)->GetType() != VARDATA_NONE && (*cur)->ommited == false) {
result += (*cur)->AsText();
result += _T(",");
n++;
}
}
if (n > 0) result = result.Left(result.Length()-1);
// Finish
if (parenthesis) result += _T(")");
return result;
}
Switch all headers to using Doxygen and cleanup contact info * Swap old email + website address with 'Aegisub Project http://www.aegisub.org/' * Set categories for all files (jfs) * Add descriptions for each file (jfs) * Add $Id$ keyword Originally committed to SVN as r3310.
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