void CMUSHclientDoc::MXP_collected_entity (void)
{
m_strMXPstring.TrimLeft ();
m_strMXPstring.TrimRight ();
// case insensitive
// m_strMXPstring.MakeLower ();
// count them
m_iMXPentities++;
// TRACE1 ("MXP collected entity %s\n", (LPCTSTR) m_strMXPstring);
MXP_error (DBG_ALL, msgMXP_CollectedEntity,
TFormat ("MXP entity: &%s;",
(LPCTSTR) m_strMXPstring));
if (!IsValidName (m_strMXPstring) && m_strMXPstring.Left (1) != "#")
{
MXP_error (DBG_ERROR, errMXP_InvalidEntityName,
TFormat ("Invalid MXP entity name \"%s\" supplied.",
m_strMXPstring));
return;
}
// see if we know of this entity
CString strEntityContents = MXP_GetEntity (m_strMXPstring);
if (!strEntityContents.IsEmpty ())
AddToLine (strEntityContents, 0);
} // end of CMUSHclientDoc::MXP_collected_entity
void CMUSHclientDoc::MXP_collected_entity (void)
{
m_strMXPstring.TrimLeft ();
m_strMXPstring.TrimRight ();
// case insensitive
// m_strMXPstring.MakeLower ();
// count them
m_iMXPentities++;
// TRACE1 ("MXP collected entity %s\n", (LPCTSTR) m_strMXPstring);
MXP_error (DBG_ALL, msgMXP_CollectedEntity,
TFormat ("MXP entity: &%s;",
(LPCTSTR) m_strMXPstring));
if (!IsValidName (m_strMXPstring) && m_strMXPstring.Left (1) != "#")
{
MXP_error (DBG_ERROR, errMXP_InvalidEntityName,
TFormat ("Invalid MXP entity name \"%s\" supplied.",
m_strMXPstring));
return;
}
// see if we know of this entity
CString strEntityContents = MXP_GetEntity (m_strMXPstring);
if (!strEntityContents.IsEmpty ())
{
// if the entity happens to be < & > etc. don't reprocess it
m_bMXP = false;
DisplayMsg (strEntityContents, strEntityContents.GetLength (), 0);
m_bMXP = true;
}
} // end of CMUSHclientDoc::MXP_collected_entity
// here for start tag, eg. <bold> <underline> <usertag>
void CMUSHclientDoc::MXP_StartTag (CString strTag)
{
// are we in secure mode right now?
bool bSecure = MXP_Secure ();
bool bNoReset = false;
MXP_Restore_Mode (); // cancel secure-once mode
static CArgumentList ArgumentList;
CString strName;
GetWord (strName, strTag);
// count them
m_iMXPtags++;
if (!IsValidName (strName))
{
MXP_error (DBG_ERROR, errMXP_InvalidElementName,
TFormat ("Invalid MXP element name \"%s\" supplied.",
strName));
return;
}
// case insensitive?
strName.MakeLower ();
// see if we know of this element
CAtomicElement * pAtomicElement = NULL;
CElement * pElement = NULL;
bool bOpen;
bool bCommand;
POSITION atompos;
// find existing styles
CStyle * pStyle = m_pCurrentLine->styleList.GetTail ();
unsigned short iFlags = pStyle->iFlags;
COLORREF iForeColour = pStyle->iForeColour;
COLORREF iBackColour = pStyle->iBackColour;
CAction * pAction = pStyle->pAction;
CString strAction;
CString strHint;
CString strVariable;
// get old action, hint etc. so that something like:
// <send href="nick"> <b> blah </b> </send> will work
// in this case we want the href (action) to persist through the <b>
if (pAction)
{
strAction = pAction->m_strAction;
strHint = pAction->m_strHint;
strVariable = pAction->m_strVariable;
} // end of having an action etc.
if (App.m_ElementMap.Lookup (strName, pAtomicElement))
{
bOpen = (pAtomicElement->iFlags & TAG_OPEN) != 0;
bCommand = (pAtomicElement->iFlags & TAG_COMMAND) != 0;
bNoReset = (pAtomicElement->iFlags & TAG_NO_RESET) != 0;
// check for mixing Pueblo and MXP tags
/*
// ALLOW BOTH for now
if ((pAtomicElement->iFlags & TAG_PUEBLO) &&
!m_bPuebloActive)
{
MXP_error (DBG_ERROR, errMXP_PuebloOnly,
TFormat ("Using Pueblo-only element in MXP mode: <%s>" ,
(LPCTSTR) strName));
return;
}
if ((pAtomicElement->iFlags & TAG_MXP) &&
m_bPuebloActive)
{
MXP_error (DBG_ERROR, errMXP_MXPOnly,
TFormat ("Using MXP-only element in Pueblo mode: <%s>" ,
(LPCTSTR) strName));
return;
}
*/
} // end of atomic element found
else
{
if (!m_CustomElementMap.Lookup (strName, pElement))
{
MXP_error (DBG_ERROR, errMXP_UnknownElement,
TFormat ("Unknown MXP element: <%s>" ,
(LPCTSTR) strName));
return;
}
pAtomicElement = NULL;
bOpen = pElement->bOpen;
bCommand = pElement->bCommand;
if (!pElement->strFlag.IsEmpty ())
strVariable = pElement->strFlag; // might have a variable to set
} // end of not atomic
// check for secure tags
if (!bOpen &&
!bSecure &&
SECURE_ELEMENT_CHECK)
{
MXP_error (DBG_ERROR, errMXP_ElementWhenNotSecure,
TFormat ("Secure MXP tag ignored when not in secure mode: <%s>" ,
(LPCTSTR) strName));
return;
}
if (BuildArgumentList (ArgumentList, strTag))
{
DELETE_LIST (ArgumentList);
return;
}
// call script if required for user-defined elements
// atomic elements have their script called in MXP_OpenAtomicTag
if ((m_dispidOnMXP_OpenTag != DISPID_UNKNOWN || m_bPluginProcessesOpenTag)
&& pAtomicElement == NULL)
{
bool bNotWanted = MXP_StartTagScript (strName, strTag, ArgumentList);
// re-get current style in case the script did a world.note
pStyle = m_pCurrentLine->styleList.GetTail ();
// put things backt to how they were
pStyle->iFlags = iFlags;
pStyle->iForeColour = iForeColour;
pStyle->iBackColour = iBackColour;
if (bNotWanted)
return; // they didn't want to go ahead with this tag
}
// If existing run is zero length, get rid of it, unless it
// is a tag marker
if (pStyle->iLength == 0 && (pStyle->iFlags & START_TAG) == 0)
{
DELETESTYLE (pStyle);
m_pCurrentLine->styleList.RemoveTail ();
}
// command tags are not popped from the stack, and thus don't need a record
if (!bCommand)
{
// add a marker to the current line for the tag itself
// this is a record of what the text style was at this point
AddStyle (iFlags | START_TAG,
iForeColour,
iBackColour,
0,
strName,
"",
strVariable);
// remember what is outstanding
CActiveTag * pTag = new CActiveTag;
pTag->strName = strName;
pTag->bSecure = bSecure;
pTag->bNoReset = bNoReset;
m_ActiveTagList.AddTail (pTag); // add to outstanding tag list
// warn if they are overdoing the outstanding tags
if (m_ActiveTagList.GetCount () % OUTSTANDING_TAG_WARNING == 0 &&
m_ActiveTagList.GetCount () != m_iLastOutstandingTagCount)
{
MXP_error (DBG_WARNING, wrnMXP_ManyOutstandingTags,
TFormat (
"Now have %i outstanding MXP tags" ,
m_ActiveTagList.GetCount ()));
m_iLastOutstandingTagCount = m_ActiveTagList.GetCount ();
}
} // end of not command tag
//if (strName == "ex")
/*
{
iFlags &= ~COLOURTYPE; // clear bits, eg. custom
iFlags |= COLOUR_RGB;
iForeColour = 255;
iBackColour = 255 * 256;
}
*/
// now add another style entry to the line - this will have the
// style adjusted for the new attributes (eg. bold)
CStyle * pNewStyle = AddStyle (iFlags & STYLE_BITS,
iForeColour,
iBackColour,
0,
NULL); // we will add the action later
// atomic element? (looked-up earlier)
if (pAtomicElement)
{
CArgument * pArgument;
for (atompos = ArgumentList.GetHeadPosition (); atompos; )
{
pArgument = ArgumentList.GetNext (atompos);
// Walk the value for &xxx; entries
if (pArgument->strValue.Find ('&') != -1)
{
const char * p = pArgument->strValue;
const char * pStart = pArgument->strValue;
CString strEntity;
CString strFixedValue;
strFixedValue.Empty ();
long length;
for ( ; *p; p++)
{
if (*p == '&')
{
// copy up to ampersand
length = p - pStart;
if (length > 0)
strFixedValue += CString (pStart, length);
p++; // skip ampersand
pStart = p; // where entity starts
for ( ; *p && *p != ';'; p++) // look for closing semicolon
; // just keep looking
if (*p != ';')
{
MXP_error (DBG_ERROR, errMXP_NoClosingSemicolonInArgument,
TFormat ("No closing \";\" in MXP element argument \"%s\"",
(LPCTSTR) pArgument->strValue));
return;
}
strEntity = CString (pStart, p - pStart); // build entity, excluding & and ;
// b. i. Look up entity in attribute list by name (eg. "col")
CString strReplacement = "&text;";
if (strEntity != "text")
strReplacement = MXP_GetEntity (strEntity);
strFixedValue += strReplacement; // add to list
pStart = p + 1; // move on past the entity
} // end of having an ampersand
} // end of processing the value
strFixedValue += pStart;
pArgument->strValue = strFixedValue;
} // end of subsitution needed
} // end of processing each argument in the atomic list
MXP_OpenAtomicTag (strName,
pAtomicElement->iAction,
pNewStyle,
strAction,
strHint,
strVariable,
ArgumentList);
// new style might have changed if they started a new line
// (eg. BR)
if (!m_pCurrentLine->styleList.IsEmpty ())
{
pNewStyle = m_pCurrentLine->styleList.GetTail ();
RememberStyle (pNewStyle);
if (pNewStyle->pAction)
{
strAction = pNewStyle->pAction->m_strAction;
strHint = pNewStyle->pAction->m_strHint;
strVariable = pNewStyle->pAction->m_strVariable;
}
}
pNewStyle->pAction = GetAction (strAction, strHint, strVariable);
DELETE_LIST (ArgumentList); // clean up memory
return;
}
// --------- end of processing for ATOMIC element ------------
// must be a user-defined element
CElementItem * pElementItem;
for (POSITION pos = pElement->ElementItemList.GetHeadPosition (); pos; )
{
pElementItem = pElement->ElementItemList.GetNext (pos);
CArgumentList BuiltArgumentList;
BuiltArgumentList.RemoveAll ();
/* we need to build up the arguments to the atomic element from 3 places:
1. The atom itself needs an argument list (eg. <COLOR &col;> )
2. The user-defined element has an attribute list that lists possible arguments
possibly with defaults, eg. col=red
3. The tag itself may supply values, eg. col=blue
These are:
1. pElementItem->ArgumentList - what the atomic element wants
2. pElement->AttributeList - what it can get, including defaults
3. ArgumentList - what is specified on *this* tag
So, I think we need to:
a. Walk the atomic item's argument list
b. For any entries in the form &xxx; ...
0. The special case &text; is left alone (for processing later)
i. Look up the entity in the attribute list (2) above.
ii. If found, go to (c).
iii. Look up entity in entities map (could be < for instance)
iv. If found, just replace it and continue
v. If not found still, error
c. If entity is found in attribute list (2) above, then:
d. Look up value in supplied arguments (3) by name and position.
e. If found, take supplied value.
f. If not found, take default from (2) including <nothing> if applicable.
Each entry gets built into BuiltArgumentList and passed down to the atomic element
processing routine.
*/
// a. Walk the atom's list
CArgument * pArgument;
int iArgumentNumber = 0;
for (atompos = pElementItem->ArgumentList.GetHeadPosition (); atompos; )
{
pArgument = pElementItem->ArgumentList.GetNext (atompos);
// b. Walk the value for &xxx; entries
const char * p = pArgument->strValue;
const char * pStart = pArgument->strValue;
CString strEntity;
CString strFixedValue;
long length;
strFixedValue.Empty ();
for ( ; *p; p++)
{
if (*p == '&')
{
// copy up to ampersand
length = p - pStart;
if (length > 0)
strFixedValue += CString (pStart, length);
p++; // skip ampersand
pStart = p; // where entity starts
for ( ; *p && *p != ';'; p++) // look for closing semicolon
; // just keep looking
if (*p != ';')
{
MXP_error (DBG_ERROR, errMXP_NoClosingSemicolonInArgument,
TFormat ("No closing \";\" in MXP element argument \"%s\"",
(LPCTSTR) pArgument->strValue));
return;
}
strEntity = CString (pStart, p - pStart); // build entity, excluding & and ;
// b. i. Look up entity in attribute list by name (eg. "col")
CString strReplacement = "&text;";
if (strEntity != "text")
{
CString strDefault;
CArgument * pAttribute = NULL;
int iSequence = 1;
for (POSITION attpos = pElement->AttributeList.GetHeadPosition ();
attpos;
iSequence++)
{
pAttribute = pElement->AttributeList.GetNext (attpos);
if (pAttribute->strName.IsEmpty ()) // no name, value is name (ie. no default)
{
if (pAttribute->strValue.CompareNoCase (strEntity) == 0)
break;
}
else
if (pAttribute->strName.CompareNoCase (strEntity) == 0)
{
strDefault = pAttribute->strValue;
break;
}
pAttribute = NULL; // indicates it wasn't found
} // end of looking for the attribute
if (pAttribute)
{
// we now have a default and a position - look it up in the supplied arguments
strReplacement = GetArgument (ArgumentList, strEntity, iSequence, false);
if (strReplacement.IsEmpty ()) // empty? take default
{
strReplacement = strDefault;
// stil empty? Warn them.
if (strReplacement.IsEmpty ())
MXP_error (DBG_WARNING, wrnMXP_ArgumentNotSupplied,
TFormat ("Non-default argument \"%s\" not supplied to <%s>",
(LPCTSTR) strEntity,
(LPCTSTR) strName
));
}
} // end of attribute found
else
strReplacement = MXP_GetEntity (strEntity);
} // end of not being the entity &text;
strFixedValue += strReplacement; // add to list
pStart = p + 1; // move on past the entity
} // end of having an ampersand
} // end of processing the value
strFixedValue += pStart;
// add fixed argument to the built argument list
CArgument * pNewArgument;
if (pArgument->strName.IsEmpty ()) // just a positional argument
{
pNewArgument = new CArgument ("", strFixedValue, ++iArgumentNumber);
BuiltArgumentList.AddTail (pNewArgument);
}
else
{
pNewArgument = new CArgument (pArgument->strName, strFixedValue, 0);
BuiltArgumentList.AddTail (pNewArgument);
}
} // end of processing each argument in the atomic list
MXP_OpenAtomicTag (pElementItem->pAtomicElement->strName,
pElementItem->pAtomicElement->iAction,
pNewStyle,
strAction,
strHint,
strVariable,
BuiltArgumentList);
DELETE_LIST (BuiltArgumentList); // just a temporary list
} // end of doing each atomic element
// new style might have changed if they started a new line
// (eg. BR)
if (!m_pCurrentLine->styleList.IsEmpty ())
{
pNewStyle = m_pCurrentLine->styleList.GetTail ();
RememberStyle (pNewStyle);
}
// make an action for the built-up action/hint/variable
pNewStyle->pAction = GetAction (strAction, strHint, strVariable);
// check all arguments used
CheckArgumentsUsed (strName, ArgumentList);
DELETE_LIST (ArgumentList); // clean up memory
} // end of CMUSHclientDoc::MXP_StartTag
// here for <!ENTITY blah>
void CMUSHclientDoc::MXP_Entity (CString strName, CString strTag)
{
// case insensitive
strName.MakeLower ();
CString strEntityContents;
if (App.m_EntityMap.Lookup (strName, strEntityContents))
{
MXP_error (DBG_ERROR, errMXP_CannotRedefineEntity,
TFormat ("Cannot redefine entity: &%s;",
(LPCTSTR) strName));
return;
}
GetWord (strEntityContents, strTag);
// blank contents deletes the entity
if (strEntityContents.IsEmpty ())
m_CustomEntityMap.RemoveKey (strName);
else
{
// look for entities imbedded in the definition, eg. <!EN blah '<Nick>'>
const char * p = strEntityContents;
const char * pStart;
CString strFixedValue;
CString strEntity;
strFixedValue.Empty ();
for ( ; *p; p++)
{
if (*p == '&')
{
p++; // skip ampersand
pStart = p; // where entity starts
for ( ; *p && *p != ';'; p++) // look for closing semicolon
; // just keep looking
if (*p != ';')
{
MXP_error (DBG_ERROR, errMXP_NoClosingSemicolon,
TFormat ("No closing \";\" in MXP entity argument \"%s\"",
(LPCTSTR) strEntityContents));
return;
}
CString s (pStart, p - pStart);
strFixedValue += MXP_GetEntity (s); // add to list
} // end of having an ampersand
else
strFixedValue += *p; // just add ordinary characters to list
} // end of processing the value
// add entity to map
m_CustomEntityMap.SetAt (strName, strFixedValue);
// tell each plugin what we have received
if (m_bPluginProcessesSetEntity)
SendToAllPluginCallbacks (ON_PLUGIN_MXP_SETENTITY,
CFormat ("%s=%s",
(LPCTSTR) strName,
(LPCTSTR) strFixedValue));
m_CurrentPlugin = NULL;
}
// check they didn't supply any other arguments
strTag.TrimLeft ();
while (!strTag.IsEmpty ())
{
CString strKeyword;
GetWord (strKeyword, strTag);
strKeyword.MakeLower ();
if (strKeyword == "desc")
{
GetWord (strKeyword, strTag);
if (strKeyword != "=")
GetWord (strKeyword, strTag); // get description
}
else if (strKeyword == "private")
{
// do nothing
}
else if (strKeyword == "publish")
{
// do nothing
}
else if (strKeyword == "delete")
{
m_CustomEntityMap.RemoveKey (strName);
}
else if (strKeyword == "add")
{
// do nothing
}
else if (strKeyword == "remove")
{
m_CustomEntityMap.RemoveKey (strName);
}
else
{
MXP_error (DBG_WARNING, errMXP_UnexpectedEntityArguments,
TFormat ("Unexpected word \"%s\" in entity definition for &%s; ignored",
(LPCTSTR) strKeyword,
(LPCTSTR) strName));
return;
}
} // of processing optional words
} // end of CMUSHclientDoc::MXP_Entity
