开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Internet/网络编程 > xml/soap/webservice > 查看源码
DocumentConverter.cpp
资源名称：openvxi-3.4.zip　[点击查看]
上传用户：xqtpzdz
上传日期：2022-05-21
资源大小：1764k
文件大小：52k
源码类别：

xml/soap/webservice

开发平台：

Visual C++

DocumentConverter.cpp：源码内容
  2. /****************License************************************************
  3.  * Vocalocity OpenVXI
  4.  * Copyright (C) 2004-2005 by Vocalocity, Inc. All Rights Reserved.
  5.  * This program is free software; you can redistribute it and/or
  6.  * modify it under the terms of the GNU General Public License
  7.  * as published by the Free Software Foundation; either version 2
  8.  * of the License, or (at your option) any later version.
  9.  *  
  10.  * This program is distributed in the hope that it will be useful,
  11.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13.  * GNU General Public License for more details.
  14.  *
  15.  * You should have received a copy of the GNU General Public License
  16.  * along with this program; if not, write to the Free Software
  17.  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18.  * Vocalocity, the Vocalocity logo, and VocalOS are trademarks or 
  19.  * registered trademarks of Vocalocity, Inc. 
  20.  * OpenVXI is a trademark of Scansoft, Inc. and used under license 
  21.  * by Vocalocity.
  22.  ***********************************************************************/
  24. /***********************************************************************
  25.  * This class performs several jobs.  Among them:
  26.  *
  27.  * 1) <grammar> contents are collapsed and blindly copied.
  28.  *
  29.  * 2) Explicit and implicit prompts are converted into <prompt> elements with
  30.  *    full SSML headers and trailers.
  31.  *    NOTE: <value>, <enumerate>, and <audio> don't contribute to the copy
  32.  *          depth as they require special handling.
  33.  *
  34.  * 3) PCDATA consisting only of whitespace is discarded.
  35.  *
  36.  * 4) <error>, <help>, <noinput> and <nomatch> are converted into a <catch>
  37.  *    with the appropriate event name.
  38.  *
  39.  * 5) <choice> elements may be assigned dtmf values.
  40.  *
  41.  * 6) Attribute conflicts are detected whenever possible.
  42.  *
  43.  * 7) <metadata> is ignored (except in <grammar> or <prompt>).
  44.  *
  45.  * 8) Assign xml:base and xml:lang to <grammar>, <prompt>, <field>, and <menu>.
  46.  * 
  47.  * NOTE: By performing these duties, the DocumentConverter greatly simplifies
  48.  *       the rest of the interpreter.  Unfortunately, this means that this
  49.  *       code is tricky to write and maintain.  PLEASE BE VERY CAREFUL THAT
  50.  *       YOU UNDERSTAND WHAT IS HAPPENING HERE BEFORE MAKING ANY CHANGES.
  51.  * 
  52.  ***********************************************************************
  53.  *
  54.  * 1 Grammar processing
  55.  *
  56.  * The content of <grammar> elements is blindly copied.  This is controlled
  57.  * by 'copyDepth' and 'inGrammar'.  This is possible because VoiceXML
  58.  * grammars are entirely static.  Reducing them down to PCDATA at this stage
  59.  * allows the interpreter to treat the entire grammar as a black box without
  60.  * regard to supported types.
  61.  *
  62.  ***********************************************************************
  63.  * 
  64.  * 2 Prompt processing 
  65.  *
  66.  * A frequently noted defect of VoiceXML is that prompts may be both explicitly
  67.  * declared (i.e. within <prompt>) or implicitly declared as raw CDATA.  In
  68.  * this code, we convert all implicit prompts into explicit ones and collapse
  69.  * most of the SSML into PCDATA.  At the end, prompts are composed only of 
  70.  * those elements requiring special handling (i.e. <audio>, <enumerate>,  
  71.  * <value>, and <foreach>) and PCDATA.
  72.  *
  73.  * In the case of <foreach>, there is extra logic for handling executable
  74.  * content within a <foreach> element.
  75.  *
  76.  ***********************************************************************
  77.  * 
  78.  * 3 Whitespace stripping
  79.  *
  80.  * Because of implicit prompts, the XML parser is required to treat most
  81.  * whitespace as significant information.  These 'empty prompts' are stripped
  82.  * at this level to simplify later processing.
  83.  *
  84.  * Likewise, <choice> and <option> content is whitespace stripped (though this
  85.  * task must be performed by the VXMLDocumentRep since Xerces may split PCDATA
  86.  * across multiple calls to DocumentConverter::characters).
  87.  *
  88.  ***********************************************************************
  89.  * 
  90.  * 4 Event collapsing
  91.  *
  92.  * VoiceXML defines <error>, <help>, <noinput> and <nomatch> as aliases
  93.  * for <catch event="...">.  These are converted at this layer (see
  94.  * startElement) to simplify later processing.
  95.  *
  96.  ***********************************************************************
  97.  * 
  98.  * 5 Menu choice processing
  99.  *
  100.  * DTMF values may be assigned to <choice>s if necessary.
  101.  *
  102.  ***********************************************************************
  103.  * 
  104.  * 6 Attribute conflict detection
  105.  *
  106.  * There are many cases in the VoiceXML specification where conflicting
  107.  * attributes result in error.badfetch.  These should (in future) be
  108.  * detected by the XML schema and are caught at this level.
  109.  *
  110.  * One difficult case appears inside of <grammar> and <script> where either
  111.  * the 'src' attribute or content is legal, but not both.  As grammars may
  112.  * not appear inside scripts and vice versa, this is detected with a simple
  113.  * scheme using the variables 'contentForbidden' and 'hasContent'.
  114.  *
  115.  ***********************************************************************
  116.  *
  117.  * 7 <metadata> stripped
  118.  *
  119.  * This content has no runtime impact.  It is stripped at this level
  120.  * UNLESS it is inside a <grammar> or <prompt> tag.
  121.  *
  122.  ***********************************************************************
  123.  *
  124.  * 8 <prompt> & <grammar> always have xml:base and xml:lang attributes.
  125.  *   <field>, <menu> always has xml:lang
  126.  *
  127.  * In an effort to keep these elements independent from the rest of VXML
  128.  * this attribute is always set.  This allows the SRGS or SSML to
  129.  * incorporate an xml:base in the root element which might be useful if
  130.  * the contents are being sent to a seperate server.
  131.  *
  132.  * Likewise, a language is required for the type attribute on fields (used
  133.  * for builtins) and for generating the CDATA grammars in menu choices.
  134.  *
  135.  ***********************************************************************/
  136.  
  137. #include "DocumentConverter.hpp"
  138. #include <sax2/Attributes.hpp>
  139. #include <sax/SAXParseException.hpp>
  140. #include <sax/Locator.hpp>
  141. #include <vector>
  142. #include <algorithm>
  143. #include <sstream>                     // by ProcessNodeFinal
  144. #include "VXMLDocument.hpp"
  145. #include "VXMLDocumentRep.hpp"
  146. #include "XMLChConverter.hpp"
  147. #include <iostream>
  148. #include <algorithm>
  150. //#############################################################################
  153. enum {
  154.   PRIV_ELEM_RangeStart    = 0x200,   // This should always be the first entry
  156.   // Events
  157.   PRIV_ELEM_ERROR,
  158.   PRIV_ELEM_HELP,
  159.   PRIV_ELEM_NOINPUT,
  160.   PRIV_ELEM_NOMATCH,
  161.   PRIV_ELEM_METADATA,
  163.   // SSML
  164.   PRIV_ELEM_BREAK,
  165.   PRIV_ELEM_DESC,
  166.   PRIV_ELEM_EMPHASIS,
  167.   PRIV_ELEM_PARAGRAPH,
  168.   PRIV_ELEM_PHONEME,
  169.   PRIV_ELEM_PROSODY,
  170.   PRIV_ELEM_SAYAS,
  171.   PRIV_ELEM_SENTENCE,
  172.   PRIV_ELEM_SUB,
  173.   PRIV_ELEM_VOICE
  174. };
  176. enum {
  177.   PRIV_ATTRIB_RangeStart  = 0x200,   // This should always be the first entry
  178.   PRIV_ATTRIB_SCHEMALOC
  179. };
  182. struct VXMLElementInfo {
  183. public:
  184.   const VXIchar * key;
  185.   int value;
  187.   VXMLElementInfo(const VXIchar * k, int v)
  188.     : key(k), value(v)  { }
  190.   VXMLElementInfo(const VXMLElementInfo & k)
  191.     : key(k.key), value(k.value)   { }
  193.   VXMLElementInfo& operator=(const VXMLElementInfo & k)
  194.     { key = k.key; value = k.value; return *this; }
  195. };
  198. bool operator< (const VXMLElementInfo & x, const VXMLElementInfo & y)
  199. { if (x.key == NULL || y.key == NULL) return false;
  200.   return wcscmp(x.key, y.key) < 0; }
  203. struct VXMLAttribute {
  204. public:
  205.   const VXIchar * key;
  206.   int value;
  208.   VXMLAttribute(const VXIchar * k, int v)
  209.     : key(k), value(v)  { }
  211.   VXMLAttribute(const VXMLAttribute & k)
  212.     : key(k.key), value(k.value)       { }
  214.   VXMLAttribute& operator=(const VXMLAttribute & k)
  215.     { key = k.key; value = k.value; return *this; }
  216. };
  219. bool operator< (const VXMLAttribute & x, const VXMLAttribute & y)
  220. { if (x.key == NULL || y.key == NULL) return false;
  221.   return wcscmp(x.key, y.key) < 0; }
  224. typedef std::vector<VXMLAttribute>   TABLE_ATTRS;
  225. typedef std::vector<VXMLElementInfo> TABLE_ELEMS;
  227. TABLE_ATTRS  g_attrs;
  228. TABLE_ELEMS  g_elems;
  230. //#############################################################################
  231.  
  232. static void InitializeTables()
  233. {
  234.   // (1) Elements
  236.   // (1.1) VXML
  237.   g_elems.push_back(VXMLElementInfo(L"assign"      , NODE_ASSIGN));
  238.   g_elems.push_back(VXMLElementInfo(L"audio"       , NODE_AUDIO));
  239.   g_elems.push_back(VXMLElementInfo(L"block"       , NODE_BLOCK));
  240.   g_elems.push_back(VXMLElementInfo(L"cancel"      , NODE_CANCEL));
  241.   g_elems.push_back(VXMLElementInfo(L"catch"       , NODE_CATCH));
  242.   g_elems.push_back(VXMLElementInfo(L"choice"      , NODE_CHOICE));
  243.   g_elems.push_back(VXMLElementInfo(L"clear"       , NODE_CLEAR));
  244.   g_elems.push_back(VXMLElementInfo(L"data"        , NODE_DATA));
  245.   g_elems.push_back(VXMLElementInfo(L"disconnect"  , NODE_DISCONNECT));
  246.   g_elems.push_back(VXMLElementInfo(L"else"        , NODE_ELSE));
  247.   g_elems.push_back(VXMLElementInfo(L"elseif"      , NODE_ELSEIF));
  248.   g_elems.push_back(VXMLElementInfo(L"enumerate"   , NODE_ENUMERATE));
  249.   g_elems.push_back(VXMLElementInfo(L"exit"        , NODE_EXIT));
  250.   g_elems.push_back(VXMLElementInfo(L"field"       , NODE_FIELD));
  251.   g_elems.push_back(VXMLElementInfo(L"filled"      , NODE_FILLED));
  252.   g_elems.push_back(VXMLElementInfo(L"foreach"     , NODE_FOREACH));
  253.   g_elems.push_back(VXMLElementInfo(L"form"        , NODE_FORM));
  254.   g_elems.push_back(VXMLElementInfo(L"goto"        , NODE_GOTO));
  255.   g_elems.push_back(VXMLElementInfo(L"grammar"     , NODE_GRAMMAR));
  256.   g_elems.push_back(VXMLElementInfo(L"if"          , NODE_IF));
  257.   g_elems.push_back(VXMLElementInfo(L"initial"     , NODE_INITIAL));
  258.   g_elems.push_back(VXMLElementInfo(L"link"        , NODE_LINK));
  259.   g_elems.push_back(VXMLElementInfo(L"log"         , NODE_LOG));
  260.   g_elems.push_back(VXMLElementInfo(L"mark"        , NODE_MARK));
  261.   g_elems.push_back(VXMLElementInfo(L"menu"        , NODE_MENU));
  262.   g_elems.push_back(VXMLElementInfo(L"meta"        , NODE_META));
  263.   g_elems.push_back(VXMLElementInfo(L"object"      , NODE_OBJECT));
  264.   g_elems.push_back(VXMLElementInfo(L"option"      , NODE_OPTION));
  265.   g_elems.push_back(VXMLElementInfo(L"param"       , NODE_PARAM));
  266.   g_elems.push_back(VXMLElementInfo(L"prompt"      , NODE_PROMPT));
  267.   g_elems.push_back(VXMLElementInfo(L"property"    , NODE_PROPERTY));
  268.   g_elems.push_back(VXMLElementInfo(L"record"      , NODE_RECORD));
  269.   g_elems.push_back(VXMLElementInfo(L"return"      , NODE_RETURN));
  270.   g_elems.push_back(VXMLElementInfo(L"reprompt"    , NODE_REPROMPT));
  271.   g_elems.push_back(VXMLElementInfo(L"script"      , NODE_SCRIPT));
  272.   g_elems.push_back(VXMLElementInfo(L"subdialog"   , NODE_SUBDIALOG));
  273.   g_elems.push_back(VXMLElementInfo(L"submit"      , NODE_SUBMIT));
  274.   g_elems.push_back(VXMLElementInfo(L"throw"       , NODE_THROW));
  275.   g_elems.push_back(VXMLElementInfo(L"transfer"    , NODE_TRANSFER));
  276.   g_elems.push_back(VXMLElementInfo(L"value"       , NODE_VALUE));
  277.   g_elems.push_back(VXMLElementInfo(L"var"         , NODE_VAR));
  278.   g_elems.push_back(VXMLElementInfo(L"vxml"        , NODE_VXML));
  280.   // (1.2) from Defaults document
  281.   g_elems.push_back(VXMLElementInfo(L"defaults"    , DEFAULTS_ROOT));
  282.   g_elems.push_back(VXMLElementInfo(L"language"    , DEFAULTS_LANGUAGE));
  284.   // (1.3) Internals elements (these are converted to others)
  285.   g_elems.push_back(VXMLElementInfo(L"error"       , PRIV_ELEM_ERROR));
  286.   g_elems.push_back(VXMLElementInfo(L"help"        , PRIV_ELEM_HELP));
  287.   g_elems.push_back(VXMLElementInfo(L"noinput"     , PRIV_ELEM_NOINPUT));
  288.   g_elems.push_back(VXMLElementInfo(L"nomatch"     , PRIV_ELEM_NOMATCH));
  289.   g_elems.push_back(VXMLElementInfo(L"metadata"    , PRIV_ELEM_METADATA));
  291.   // (1.4) SSML
  292.   g_elems.push_back(VXMLElementInfo(L"break"       , PRIV_ELEM_BREAK));
  293.   g_elems.push_back(VXMLElementInfo(L"desc"        , PRIV_ELEM_DESC));
  294.   g_elems.push_back(VXMLElementInfo(L"emphasis"    , PRIV_ELEM_EMPHASIS));
  295.   g_elems.push_back(VXMLElementInfo(L"p"           , PRIV_ELEM_PARAGRAPH));
  296.   g_elems.push_back(VXMLElementInfo(L"paragraph"   , PRIV_ELEM_PARAGRAPH));
  297.   g_elems.push_back(VXMLElementInfo(L"phoneme"     , PRIV_ELEM_PHONEME));
  298.   g_elems.push_back(VXMLElementInfo(L"prosody"     , PRIV_ELEM_PROSODY));
  299.   g_elems.push_back(VXMLElementInfo(L"s"           , PRIV_ELEM_SENTENCE));
  300.   g_elems.push_back(VXMLElementInfo(L"say-as"      , PRIV_ELEM_SAYAS));
  301.   g_elems.push_back(VXMLElementInfo(L"sentence"    , PRIV_ELEM_SENTENCE));
  302.   g_elems.push_back(VXMLElementInfo(L"sub"         , PRIV_ELEM_SUB));
  303.   g_elems.push_back(VXMLElementInfo(L"voice"       , PRIV_ELEM_VOICE));
  305.   // (2) Element attributes
  307.   // (2.1) VXML 1.0
  308.   g_attrs.push_back(VXMLAttribute(L"_itemname"     , ATTRIBUTE__ITEMNAME));
  309.   g_attrs.push_back(VXMLAttribute(L"aai"           , ATTRIBUTE_AAI));
  310.   g_attrs.push_back(VXMLAttribute(L"aaiexpr"       , ATTRIBUTE_AAIEXPR));
  311.   g_attrs.push_back(VXMLAttribute(L"accept"        , ATTRIBUTE_ACCEPT));
  312.   g_attrs.push_back(VXMLAttribute(L"application"   , ATTRIBUTE_APPLICATION));
  313.   g_attrs.push_back(VXMLAttribute(L"archive"       , ATTRIBUTE_ARCHIVE));
  314.   g_attrs.push_back(VXMLAttribute(L"array"         , ATTRIBUTE_ARRAY));
  315.   g_attrs.push_back(VXMLAttribute(L"bargein"       , ATTRIBUTE_BARGEIN));
  316.   g_attrs.push_back(VXMLAttribute(L"bargeintype"   , ATTRIBUTE_BARGEINTYPE));
  317.   g_attrs.push_back(VXMLAttribute(L"base"          , ATTRIBUTE_BASE));
  318.   g_attrs.push_back(VXMLAttribute(L"beep"          , ATTRIBUTE_BEEP));
  319.   g_attrs.push_back(VXMLAttribute(L"bridge"        , ATTRIBUTE_BRIDGE));
  320.   g_attrs.push_back(VXMLAttribute(L"charset"       , ATTRIBUTE_CHARSET));
  321.   g_attrs.push_back(VXMLAttribute(L"classid"       , ATTRIBUTE_CLASSID));
  322.   g_attrs.push_back(VXMLAttribute(L"codebase"      , ATTRIBUTE_CODEBASE));
  323.   g_attrs.push_back(VXMLAttribute(L"codetype"      , ATTRIBUTE_CODETYPE));
  324.   g_attrs.push_back(VXMLAttribute(L"cond"          , ATTRIBUTE_COND));
  325.   g_attrs.push_back(VXMLAttribute(L"connecttimeout", ATTRIBUTE_CONNECTTIME));
  326.   g_attrs.push_back(VXMLAttribute(L"content"       , ATTRIBUTE_CONTENT));
  327.   g_attrs.push_back(VXMLAttribute(L"count"         , ATTRIBUTE_COUNT));
  328.   g_attrs.push_back(VXMLAttribute(L"data"          , ATTRIBUTE_DATA));
  329.   g_attrs.push_back(VXMLAttribute(L"dest"          , ATTRIBUTE_DEST));
  330.   g_attrs.push_back(VXMLAttribute(L"destexpr"      , ATTRIBUTE_DESTEXPR));
  331.   g_attrs.push_back(VXMLAttribute(L"dtmf"          , ATTRIBUTE_DTMF));
  332.   g_attrs.push_back(VXMLAttribute(L"dtmfterm"      , ATTRIBUTE_DTMFTERM));
  333.   g_attrs.push_back(VXMLAttribute(L"enctype"       , ATTRIBUTE_ENCTYPE));
  334.   g_attrs.push_back(VXMLAttribute(L"event"         , ATTRIBUTE_EVENT));
  335.   g_attrs.push_back(VXMLAttribute(L"eventexpr"     , ATTRIBUTE_EVENTEXPR));
  336.   g_attrs.push_back(VXMLAttribute(L"expr"          , ATTRIBUTE_EXPR));
  337.   g_attrs.push_back(VXMLAttribute(L"expritem"      , ATTRIBUTE_EXPRITEM));
  338.   g_attrs.push_back(VXMLAttribute(L"fetchaudio"    , ATTRIBUTE_FETCHAUDIO));
  339.   g_attrs.push_back(VXMLAttribute(L"fetchhint"     , ATTRIBUTE_FETCHHINT));
  340.   g_attrs.push_back(VXMLAttribute(L"fetchtimeout"  , ATTRIBUTE_FETCHTIMEOUT));
  341.   g_attrs.push_back(VXMLAttribute(L"finalsilence"  , ATTRIBUTE_FINALSILENCE));
  342.   g_attrs.push_back(VXMLAttribute(L"http-equiv"    , ATTRIBUTE_HTTP_EQUIV));
  343.   g_attrs.push_back(VXMLAttribute(L"id"            , ATTRIBUTE_ID));
  344.   g_attrs.push_back(VXMLAttribute(L"item"          , ATTRIBUTE_ITEM));
  345.   g_attrs.push_back(VXMLAttribute(L"label"         , ATTRIBUTE_LABEL));
  346.   g_attrs.push_back(VXMLAttribute(L"maxage"        , ATTRIBUTE_MAXAGE));
  347.   g_attrs.push_back(VXMLAttribute(L"maxstale"      , ATTRIBUTE_MAXSTALE));
  348.   g_attrs.push_back(VXMLAttribute(L"maxtime"       , ATTRIBUTE_MAXTIME));
  349.   g_attrs.push_back(VXMLAttribute(L"message"       , ATTRIBUTE_MESSAGE));
  350.   g_attrs.push_back(VXMLAttribute(L"messageexpr"   , ATTRIBUTE_MESSAGEEXPR));
  351.   g_attrs.push_back(VXMLAttribute(L"method"        , ATTRIBUTE_METHOD));
  352.   g_attrs.push_back(VXMLAttribute(L"modal"         , ATTRIBUTE_MODAL));
  353.   g_attrs.push_back(VXMLAttribute(L"mode"          , ATTRIBUTE_MODE));
  354.   g_attrs.push_back(VXMLAttribute(L"name"          , ATTRIBUTE_NAME));
  355.   g_attrs.push_back(VXMLAttribute(L"nameexpr"      , ATTRIBUTE_NAMEEXPR));
  356.   g_attrs.push_back(VXMLAttribute(L"namelist"      , ATTRIBUTE_NAMELIST));
  357.   g_attrs.push_back(VXMLAttribute(L"next"          , ATTRIBUTE_NEXT));
  358.   g_attrs.push_back(VXMLAttribute(L"nextitem"      , ATTRIBUTE_NEXTITEM));
  359.   g_attrs.push_back(VXMLAttribute(L"root"          , ATTRIBUTE_ROOT));
  360.   g_attrs.push_back(VXMLAttribute(L"scope"         , ATTRIBUTE_SCOPE));
  361.   g_attrs.push_back(VXMLAttribute(L"slot"          , ATTRIBUTE_SLOT));
  362.   g_attrs.push_back(VXMLAttribute(L"src"           , ATTRIBUTE_SRC));
  363.   g_attrs.push_back(VXMLAttribute(L"srcexpr"       , ATTRIBUTE_SRCEXPR));
  364.   g_attrs.push_back(VXMLAttribute(L"tag-format"    , ATTRIBUTE_TAGFORMAT));
  365.   g_attrs.push_back(VXMLAttribute(L"timeout"       , ATTRIBUTE_TIMEOUT));
  366.   g_attrs.push_back(VXMLAttribute(L"transferaudio" , ATTRIBUTE_TRANSFERAUDIO));
  367.   g_attrs.push_back(VXMLAttribute(L"type"          , ATTRIBUTE_TYPE));
  368.   g_attrs.push_back(VXMLAttribute(L"value"         , ATTRIBUTE_VALUE));
  369.   g_attrs.push_back(VXMLAttribute(L"valuetype"     , ATTRIBUTE_VALUETYPE));
  370.   g_attrs.push_back(VXMLAttribute(L"version"       , ATTRIBUTE_VERSION));
  371.   g_attrs.push_back(VXMLAttribute(L"weight"        , ATTRIBUTE_WEIGHT));
  372.   g_attrs.push_back(VXMLAttribute(L"xml:lang"      , ATTRIBUTE_XMLLANG));
  374.   // (2.2) Internals attributes (these are converted to others)
  375.   g_attrs.push_back(VXMLAttribute(L"schemaLocation", PRIV_ATTRIB_SCHEMALOC));
  378.   // (3) Final stuff.
  379.   std::sort(g_attrs.begin(), g_attrs.end());
  380.   std::sort(g_elems.begin(), g_elems.end());
  381. }
  384. static void DeinitializeTables()
  385. {
  386.   g_attrs.clear();
  387.   g_elems.clear();
  388. }
  391. static bool ConvertElement(const VXIchar * name, int & result)
  392. {
  393.   if (name == NULL) return false;
  395.   TABLE_ELEMS::iterator i = std::lower_bound(g_elems.begin(), g_elems.end(),
  396.                                              VXMLElementInfo(name, NODE_IF));
  398.   if (wcscmp(name, (*i).key) != 0) return false;
  400.   result = (*i).value;
  401.   return true;
  402. }
  405. static bool ConvertAttribute(const VXIchar * name, int & result)
  406. {
  407.   if (name == NULL) return false;
  409.   TABLE_ATTRS::iterator i = std::lower_bound(g_attrs.begin(), g_attrs.end(),
  410.                                              VXMLAttribute(name,ATTRIBUTE_ID));
  412.   if (wcscmp(name, (*i).key) != 0) return false;
  414.   result = (*i).value;
  416.   return true;
  417. }
  419. inline static void TrimUriBase(vxistring & uri)
  420. {
  421.   vxistring::size_type pos = uri.rfind(L'?');
  422.   if( pos != vxistring::npos )
  423.     uri.erase(pos);    
  424. }
  426. //#############################################################################
  428. class DummyLocator : public Locator {
  429. public:
  430.   DummyLocator()  { }
  431.   virtual ~DummyLocator() { }
  432.   virtual const XMLCh* getPublicId() const    { return NULL; }
  433.   virtual const XMLCh* getSystemId() const    { return NULL; }
  434.   virtual XMLSSize_t getLineNumber() const    { return -1; }
  435.   virtual XMLSSize_t getColumnNumber() const  { return -1; }
  436. };
  438. static DummyLocator DUMMYLOCATOR;
  440. //#############################################################################
  442. bool DocumentConverter::Initialize()
  443. {
  444.   InitializeTables();
  445.   return true;
  446. }
  449. void DocumentConverter::Deinitialize()
  450. {
  451.   DeinitializeTables();
  452. }
  455. DocumentConverter::DocumentConverter()
  456.   : locator(&DUMMYLOCATOR), doc(NULL), documentLevel(DOCUMENT),
  457.     copyDepth(0), pcdataImpliesPrompt(true), contentForbidden(false), hasContent(true),
  458.     inCDATA(false), foreachImplicit(false)
  459. {
  460. }
  463. DocumentConverter::~DocumentConverter()
  464. {
  465.   ResetDocument();
  466. }
  468. // remove all irrelavant part from the base uri
  469. void DocumentConverter::SetBaseUri(const VXIchar* const base) 
  470. { 
  471.   if( base != NULL ) {
  472.     baseUri = base; 
  473.   }
  474.   else baseUri=L"";  
  475. }
  477. void DocumentConverter::RestoreBaseURLFromCache(const VXMLDocument & doc)
  478. {
  479.   vxistring baseURL;
  480.   doc.GetBaseURL(baseURL);
  481.   if( !baseURL.empty() ) SetBaseUri(baseURL.c_str());
  482. }
  484. // Restore default language id if read from cache
  485. void DocumentConverter::RestoreDefaultLangFromCache(const VXMLDocument & doc)
  486. {
  487.   doc.GetDefaultLang(defaultLang);
  488. }
  490. void DocumentConverter::ParseException(const VXIchar * message) const
  491. {
  492.   if (message == NULL) throw SAXParseException(NULL, *locator);
  494.   VXIcharToXMLCh text(message);
  495.   throw SAXParseException(text.c_str(), *locator);
  496. }
  499. void DocumentConverter::startDocument()
  500. {
  501.   version = -1;
  502.   choiceNumber = 0;
  503.   inGrammar = false;
  504.   implicitPrompt = false;
  505.   explicitPrompt = 0;
  506.   copyDepth = 0;
  507.   ignoreDepth = 0;
  508.   pcdataImpliesPrompt = true;
  509.   
  510.   // Don't know the language yet!
  511.   documentLang=L"";
  513.   if (doc != NULL) VXMLDocumentRep::Release(doc);
  514.   doc = new VXMLDocumentRep();
  515.   if (doc == NULL)
  516.     ParseException(L"unable to allocate memory for element");
  517. }
  520. void DocumentConverter::endDocument()
  521. {
  522.   if ( !filledNameList.empty() && !namedControlItems.empty() ){
  523.     while(!filledNameList.empty()){
  524.       vxistring namelist = filledNameList.front();
  525.       filledNameList.pop_front();
  527.       std::basic_stringstream<VXIchar> namestream(namelist);
  528.       while (namestream.good()) {
  529.         vxistring temp;
  530.         namestream >> temp;
  531.         if (!temp.empty()){
  532.           if ( std::find(
  533.               namedControlItems.begin(),
  534.               namedControlItems.end(),
  535.               temp) != namedControlItems.end()){
  536.               ParseException(L"filled namelist cannot contain control items");
  537.             }
  538.         }
  539.       }
  540.     }
  541.   }
  542. } 
  545. void DocumentConverter::ResetDocument()
  546. {
  547.   if (doc != NULL) VXMLDocumentRep::Release(doc);
  548.   doc = NULL;
  549. }
  552. VXMLDocumentRep * DocumentConverter::GetDocument()
  553. {
  554.   VXMLDocumentRep * temp = doc;
  555.   doc = NULL;
  556.   return temp;
  557. }
  560. void DocumentConverter::setDocumentLocator(const Locator* const loc)
  561. {
  562.   if (loc == NULL)
  563.     locator = &DUMMYLOCATOR;
  564.   else
  565.     locator = loc;
  566. }
  569. void DocumentConverter::startElement(const XMLCh* const uri,
  570.                                      const XMLCh* const localname,
  571.                                      const XMLCh* const qname,
  572.                                      const Attributes & attrs)
  573. {
  574.   // (0) Just ignore this?
  575.   if (ignoreDepth > 0) {
  576.     ++ignoreDepth;
  577.     return;
  578.   }
  580.   // (1) Copy this element or look it up?
  582.   // (1.1) Inside a <grammar>, we can blindly copy this data.
  583.   if (inGrammar) {
  584.     CopyElementStart(localname, attrs);
  585.     return;
  586.   }
  588.   // (1.2) Convert name string to integer value.
  589.   XMLChToVXIchar elementName(localname);
  590.   int rawElemType;
  591.   bool conversionFailed = !ConvertElement(elementName.c_str(), rawElemType);
  593.   // (1.3) Copy almost anything inside a <prompt>.
  594.   if (explicitPrompt) {
  595.     if (conversionFailed) {
  596.       CopyElementStart(localname, attrs);
  597.       return;
  598.     }
  600.     switch (rawElemType) {
  601.     // elements that could be children of <foreach> but cannot 
  602.     // be converted to SSML text
  603.     case NODE_AUDIO:
  604.     case NODE_VALUE:
  605.     case NODE_ENUMERATE:
  606.     case NODE_FOREACH:
  607.     case NODE_MARK:
  608.     case NODE_ASSIGN:
  609.     case NODE_EXIT:
  610.     case NODE_LOG:
  611.     case NODE_IF:
  612.     case NODE_ELSE:
  613.     case NODE_ELSEIF:
  614.     case NODE_CLEAR:
  615.     case NODE_DATA:
  616.     case NODE_DISCONNECT:
  617.     case NODE_GOTO:
  618.     case NODE_SUBMIT:
  619.     case NODE_VAR:
  620.     case NODE_RETURN:
  621.     case NODE_SCRIPT:
  622.     case NODE_REPROMPT:
  623.     case NODE_THROW:
  624.       break;
  626.     // ignore nested prompts
  627.     case NODE_PROMPT:
  628.       explicitPrompt++;
  629.       return;
  631.     // all other elements in an explicit prompt get
  632.     // converted to SSML text now
  633.     default:
  634.       CopyElementStart(localname, attrs);
  635.       return;
  636.     }
  637.   }
  639.   // (1.4) Print errors for all other conversion failures.
  640.   if (conversionFailed) {
  641.     vxistring temp(L"unrecognized element - ");
  642.     temp += elementName.c_str();
  643.     ParseException(temp.c_str());
  644.   }
  646.   // (2) Check for ignored nodes and do version number processing.
  648.   if (rawElemType == PRIV_ELEM_METADATA) {
  649.     ignoreDepth = 1;
  650.     return;
  651.   }
  653.   // (2.1) Catch illegal nodes and do version number processing.  Prompt and
  654.   //       grammar copying flags are set in the same pass.
  656.   switch (rawElemType) {
  657.   case DEFAULTS_ROOT:
  658.     version = 2.0f;
  659.     break;
  660.   case NODE_VXML:
  661.     {
  662.       for (unsigned int index = 0; index < attrs.getLength(); ++index) {
  663.         if (!Compare(attrs.getLocalName(index), L"version")) continue;
  664.         const XMLCh * attributeValue = attrs.getValue(index);
  665.         if (Compare(attributeValue, L"2.0")) version = 2.0f;
  666.         else if (Compare(attributeValue, L"2.1")) version = 2.1f;
  667.         else ParseException(L"unsupported vxml version");
  668.         break;
  669.       }
  670.     }
  671.     break;
  672.   case NODE_GRAMMAR:      // Copy grammar contents.
  673.     inGrammar = true;
  674.     copyDepth = 0;
  675.     break;
  677.   case NODE_PROMPT:
  678.     // if inside a foreach element, simply ignore prompt elements
  679.     if (foreachImplicit) {
  680.       return;
  681.     }
  683.     // keep track of the number of explicit prompt elements we
  684.     // reach since a foreach element could follow, which in
  685.     // turn could contain prompt elements.
  686.     explicitPrompt++;
  687.     if (explicitPrompt == 1)
  688.       copyDepth = 0;
  689.     break;
  691.   case NODE_SCRIPT:
  692.   case NODE_CHOICE:       // These may have PCDATA which is not a prompt
  693.   case NODE_OPTION:
  694.   case NODE_LOG:   
  695.     pcdataImpliesPrompt = false;
  696.     break;
  697.   default:
  698.     break;
  699.   }
  701.   // (2.2) Is this the beginning or end of an implicit prompt?
  703.   switch (rawElemType) {
  704.   // these will start an implicit prompt, but cannot be converted
  705.   // to SSML text because they must be evaluated during runtime
  706.   case NODE_AUDIO:
  707.   case NODE_VALUE:        // NOTE: A <value> may also appear in <log>.
  708.   case NODE_ENUMERATE:
  709.   case NODE_MARK:
  710.     if (pcdataImpliesPrompt && !implicitPrompt && !explicitPrompt)
  711.       StartImplicitPrompt();
  712.     break;
  714.   // a foreach that isn't within a <prompt> will start an
  715.   // implicit prompt
  716.   case NODE_FOREACH:
  717.     if (implicitPrompt)
  718.       foreachImplicit = true;
  719.     else if (!implicitPrompt && !explicitPrompt) {
  720.       foreachImplicit = true;
  721.       StartImplicitPrompt();
  722.     }
  723.     break;
  725.   // SSML elements will trigger an implicit prompt, and get
  726.   // converted to SSML text now
  727.   case PRIV_ELEM_BREAK:   
  728.   case PRIV_ELEM_EMPHASIS:
  729.   case PRIV_ELEM_PARAGRAPH:
  730.   case PRIV_ELEM_PHONEME:
  731.   case PRIV_ELEM_PROSODY:
  732.   case PRIV_ELEM_SAYAS:
  733.   case PRIV_ELEM_SENTENCE:
  734.   case PRIV_ELEM_VOICE:
  735.     if (!implicitPrompt)
  736.       StartImplicitPrompt();
  737.     CopyElementStart(localname, attrs);
  738.     return;
  740.   // executable content that shouldn't end an implicit prompt if
  741.   // if within a foreach
  742.   case NODE_ASSIGN:
  743.   case NODE_EXIT:
  744.   case NODE_LOG:
  745.   case NODE_IF:
  746.   case NODE_ELSE:
  747.   case NODE_ELSEIF:
  748.   case NODE_CLEAR:
  749.   case NODE_DATA:
  750.   case NODE_DISCONNECT:
  751.   case NODE_GOTO:
  752.   case NODE_SUBMIT:
  753.   case NODE_VAR:
  754.   case NODE_RETURN:
  755.   case NODE_SCRIPT:
  756.   case NODE_REPROMPT:
  757.   case NODE_THROW:
  758.     if (foreachImplicit)
  759.       break;
  760. // fall through intentional
  761.   default:
  762.     if (implicitPrompt) {
  763.       if (copyDepth == 0)
  764.         EndImplicitPrompt();
  765.       else
  766.         ParseException(L"illegal prompt content");
  767.     }
  768.     break;
  769.   }
  771.   // (2.4) Convert nodes as necessary.
  773.   VXMLElementType elemType = VXMLElementType(rawElemType);
  775.   switch (rawElemType) {
  776.   case PRIV_ELEM_ERROR:
  777.   case PRIV_ELEM_HELP:
  778.   case PRIV_ELEM_NOINPUT:
  779.   case PRIV_ELEM_NOMATCH:
  780.     elemType = NODE_CATCH;
  781.     break;
  782.   default:
  783.     break;
  784.   }
  786.   if (elemType > PRIV_ELEM_RangeStart) {
  787.     vxistring temp(L"internal error for element - ");
  788.     temp += elementName.c_str();
  789.     ParseException(temp.c_str());
  790.   }
  792.   // (3) Create new element.
  794.   try {
  795.     hasContent = (elemType != NODE_SCRIPT && elemType != NODE_GRAMMAR);
  796.     doc->StartElement(elemType, documentLevel);
  797.   }
  798.   catch (const VXMLDocumentModel::OutOfMemory &) {
  799.     ParseException(L"unable to allocate memory for element");
  800.   }
  801.   catch (const VXMLDocumentModel::InternalError &) {
  802.     ParseException(L"corrupted document tree; unable to add element");
  803.   }
  805.   // (4) Add attributes to element.
  807.   int attrGroup1 = 0; 
  808.   int attrGroup2 = 0; 
  809.   int attrGroup3 = 0; 
  811.   // (4.1) Do special handling for converted nodes.
  812.   switch (rawElemType) {
  813.   case PRIV_ELEM_ERROR:
  814.     ProcessNodeAttribute(elemType, ATTRIBUTE_EVENT, L"error");
  815.     break;
  816.   case PRIV_ELEM_HELP:
  817.     ProcessNodeAttribute(elemType, ATTRIBUTE_EVENT, L"help");
  818.     break;
  819.   case PRIV_ELEM_NOINPUT:
  820.     ProcessNodeAttribute(elemType, ATTRIBUTE_EVENT, L"noinput");
  821.     break;
  822.   case PRIV_ELEM_NOMATCH:
  823.     ProcessNodeAttribute(elemType, ATTRIBUTE_EVENT, L"nomatch");
  824.     break;
  825.   default:
  826.     break;
  827.   }
  829.   bool foundResourceBaseURI  = false;
  830.   bool foundResourceBaseLang = false;
  832.   for (unsigned int index = 0; index < attrs.getLength(); ++index) {
  833.     // (4.2) Convert string to integer.
  835.     int attrType;
  836.     XMLChToVXIchar attributeName(attrs.getLocalName(index));
  838.     if (Compare(attrs.getQName(index), L"xml:lang")) {
  839.       attrType = ATTRIBUTE_XMLLANG;     
  840.     }
  841.     else if (!ConvertAttribute(attributeName.c_str(), attrType)) {
  842.       vxistring temp(L"unrecognized attribute - ");
  843.       temp += attributeName.c_str();
  844.       ParseException(temp.c_str());
  845.     }
  847.     // (4.3) Impose attribute restrictions not representable in schema 1.0.
  849.     switch (elemType) {
  850.     case NODE_AUDIO:
  851.       if (attrType == ATTRIBUTE_SRC)          ++attrGroup1;
  852.       if (attrType == ATTRIBUTE_EXPR)         ++attrGroup1;
  853.       break;
  854.     case NODE_DATA:
  855.       if (attrType == ATTRIBUTE_SRC)          ++attrGroup1;
  856.       if (attrType == ATTRIBUTE_SRCEXPR)      ++attrGroup1;
  857.       break;
  858.     case NODE_CHOICE:
  859.     case NODE_LINK:
  860.       if (attrType == ATTRIBUTE_NEXT)         ++attrGroup1;
  861.       if (attrType == ATTRIBUTE_EXPR)         ++attrGroup1;
  862.       if (attrType == ATTRIBUTE_EVENT)        ++attrGroup1;
  863.       if (attrType == ATTRIBUTE_EVENTEXPR)    ++attrGroup1;
  864.       // and...
  865.       if (attrType == ATTRIBUTE_MESSAGE)      ++attrGroup2;
  866.       if (attrType == ATTRIBUTE_MESSAGEEXPR)  ++attrGroup2;
  867.       break;
  868.     case NODE_EXIT:
  869.       if (attrType == ATTRIBUTE_EXPR)         ++attrGroup1;
  870.       if (attrType == ATTRIBUTE_NAMELIST)     ++attrGroup1;
  871.       break;
  872.     case NODE_GOTO:
  873.       if (attrType == ATTRIBUTE_NEXT)         ++attrGroup1;
  874.       if (attrType == ATTRIBUTE_EXPR)         ++attrGroup1;
  875.       if (attrType == ATTRIBUTE_NEXTITEM)     ++attrGroup1;
  876.       if (attrType == ATTRIBUTE_EXPRITEM)     ++attrGroup1;
  877.       break;
  878.     case NODE_GRAMMAR:
  879.       if (attrType == ATTRIBUTE_SRC){
  880.          contentForbidden = true;
  881.          ++attrGroup1;
  882.       }
  883.       if (attrType == ATTRIBUTE_SRCEXPR){
  884.          contentForbidden = true;
  885.          ++attrGroup1;
  886.       }
  887.       break;
  888.     case NODE_MARK:
  889.       if (attrType == ATTRIBUTE_NAME)         ++attrGroup1;
  890.       if (attrType == ATTRIBUTE_NAMEEXPR)     ++attrGroup1;
  891.       break;
  892.     case NODE_META:
  893.       if (attrType == ATTRIBUTE_NAME)         ++attrGroup1;
  894.       if (attrType == ATTRIBUTE_HTTP_EQUIV)   ++attrGroup1;
  895.       break;
  896.     case NODE_PARAM:
  897.       if (attrType == ATTRIBUTE_EXPR)         ++attrGroup1;
  898.       if (attrType == ATTRIBUTE_VALUE)        ++attrGroup1;
  899.       break;
  900.     case NODE_RETURN:
  901.       if (attrType == ATTRIBUTE_EVENT)        ++attrGroup1;
  902.       if (attrType == ATTRIBUTE_EVENTEXPR)    ++attrGroup1;
  903.       if (attrType == ATTRIBUTE_NAMELIST)     ++attrGroup1;
  904.       // and...
  905.       if (attrType == ATTRIBUTE_MESSAGE)      ++attrGroup2;
  906.       if (attrType == ATTRIBUTE_MESSAGEEXPR)  ++attrGroup2;
  907.       break;
  908.     case NODE_SCRIPT:
  909.       if (attrType == ATTRIBUTE_SRC){
  910.          contentForbidden = true;
  911.          ++attrGroup1;
  912.       }
  913.       if (attrType == ATTRIBUTE_SRCEXPR){
  914.          contentForbidden = true;
  915.          ++attrGroup1;
  916.       }
  917.       break;
  918.     case NODE_SUBDIALOG:
  919.       if (attrType == ATTRIBUTE_SRC)          ++attrGroup1;
  920.       if (attrType == ATTRIBUTE_SRCEXPR)      ++attrGroup1;
  921.       break;
  922.     case NODE_SUBMIT:
  923.       if (attrType == ATTRIBUTE_NEXT)         ++attrGroup1;
  924.       if (attrType == ATTRIBUTE_EXPR)         ++attrGroup1;
  925.       break;
  926.     case NODE_THROW:
  927.       if (attrType == ATTRIBUTE_EVENT)        ++attrGroup1;
  928.       if (attrType == ATTRIBUTE_EVENTEXPR)    ++attrGroup1;
  929.       // and...
  930.       if (attrType == ATTRIBUTE_MESSAGE)      ++attrGroup2;
  931.       if (attrType == ATTRIBUTE_MESSAGEEXPR)  ++attrGroup2;
  932.       break;
  933.     case NODE_TRANSFER:
  934.       if (attrType == ATTRIBUTE_DEST)         ++attrGroup1;
  935.       if (attrType == ATTRIBUTE_DESTEXPR)     ++attrGroup1;
  936.       // and...
  937.       if (attrType == ATTRIBUTE_AAI)          ++attrGroup2;
  938.       if (attrType == ATTRIBUTE_AAIEXPR)      ++attrGroup2;
  939.       // and...
  940.       if (attrType == ATTRIBUTE_BRIDGE)       ++attrGroup3;
  941.       if (attrType == ATTRIBUTE_TYPE)         ++attrGroup3;
  942.       break;
  943.     }
  945.     // Handle base URI resolution and xml:lang for <prompt> & <grammar>
  946.     switch (elemType) {
  947.     case NODE_PROMPT:
  948.     case NODE_GRAMMAR: 
  949.       if (attrType == ATTRIBUTE_XMLLANG)   foundResourceBaseLang = true;
  950.       else if (attrType == ATTRIBUTE_BASE) foundResourceBaseURI  = true;
  951.       else if (attrType == ATTRIBUTE_TYPE) {
  952.         // set grammar type for this grammar element
  953.         XMLChToVXIchar attributeValue(attrs.getValue(index));
  954.         SetGrammarType(attributeValue.c_str());
  955.       }
  956.       break;
  957.     case NODE_VXML:
  958.       if (attrType == ATTRIBUTE_BASE) {
  959.         XMLChToVXIchar attributeValue(attrs.getValue(index));
  960.         SetBaseUri(attributeValue.c_str());
  961.         doc->rootBaseURL = attributeValue.c_str();
  962.         continue;
  963.       }
  964.       else if (attrType == ATTRIBUTE_XMLLANG) {
  965.         XMLChToVXIchar attributeValue(attrs.getValue(index));
  966.         documentLang = attributeValue.c_str();
  967.         continue;
  968.       }
  969.       break;
  970.     case DEFAULTS_ROOT:
  971.       if (attrType == ATTRIBUTE_XMLLANG) {
  972.         XMLChToVXIchar attributeValue(attrs.getValue(index));
  973.         defaultLang = attributeValue.c_str();
  974.         documentLang = defaultLang;
  975.         continue;
  976.       }
  977.       break;
  978.     }
  979.     
  980.     // (4.5) Handle internal values.
  981.     XMLChToVXIchar attributeValue(attrs.getValue(index));
  982.     ProcessNodeAttribute(elemType, attrType, attributeValue.c_str());
  983.   }
  985.   // Use the default language for this document if necessary.
  986.   if (elemType == NODE_VXML && documentLang.empty()) {
  987.     documentLang = defaultLang;
  988.   }
  989.       
  990.   // Assign an xml:base and/or xml:lang if not already specified for every
  991.   // <grammar>, <prompt>, and <field> (because of builtins).
  992.   if (elemType == NODE_PROMPT || elemType == NODE_GRAMMAR ||
  993.       elemType == NODE_FIELD  || elemType == NODE_MENU)
  994.   {
  995.     if (!foundResourceBaseURI) 
  996.       doc->AddAttribute(ATTRIBUTE_BASE, baseUri.c_str());
  997.     if (!foundResourceBaseLang) {
  998.       doc->AddAttribute(ATTRIBUTE_XMLLANG, documentLang.c_str());      
  999.     }
  1000.   }
  1002.   // (5) Generate errors for attribute restrictions.
  1003.   switch (elemType) {
  1004.   case NODE_AUDIO:
  1005.     if (attrGroup1 != 1)
  1006.       ParseException(L"exactly one of 'src' or 'expr' must be specified");
  1007.     break;
  1008.   case NODE_DATA:
  1009.     if (attrGroup1 != 1)
  1010.       ParseException(L"exactly one of 'src' or 'srcexpr' must be specified");
  1011.     break;
  1012.   case NODE_CHOICE:
  1013.   case NODE_LINK:
  1014.     if (attrGroup1 != 1)
  1015.       ParseException(L"exactly one of 'next', 'expr', 'event' or 'eventexpr' "
  1016.                      L"must be specified");
  1017.     if (attrGroup2 > 1)
  1018.       ParseException(L"exactly one of 'message' or 'messageexpr' "
  1019.                      L"may be specified");
  1020.     break;
  1021.   case NODE_EXIT:
  1022.     if (attrGroup1 > 1)
  1023.       ParseException(L"exactly one of 'expr' or 'namelist' "
  1024.                      L"may be specified");
  1025.     break;
  1026.   case NODE_GOTO:
  1027.     if (attrGroup1 != 1)
  1028.       ParseException(L"exactly one of 'next', 'expr', 'nextitem' or 'expritem'"
  1029.                      L" must be specified");
  1030.     break;
  1031.   case NODE_MARK:
  1032.     if (attrGroup1 != 1)
  1033.       ParseException(L"exactly one of 'name' or 'nameexpr' "
  1034.                      L"must be specified");
  1035.     break;
  1036.   case NODE_META:
  1037.     if (attrGroup1 != 1)
  1038.       ParseException(L"exactly one of 'name' or 'http-equiv' "
  1039.                      L"must be specified");
  1040.     break;
  1041.   case NODE_PARAM:
  1042.     if (attrGroup1 != 1)
  1043.       ParseException(L"exactly one of 'expr' or 'value' must be specified");
  1044.     break;
  1045.   case NODE_RETURN:
  1046.     if (attrGroup1 > 1)
  1047.       ParseException(L"exactly one of 'event', 'eventexpr' or 'namelist' "
  1048.                      L"may be specified");
  1049.     if (attrGroup2 > 1)
  1050.       ParseException(L"exactly one of 'message' or 'messageexpr' "
  1051.                      L"may be specified");
  1052.     break;
  1053.   case NODE_GRAMMAR:
  1054.   case NODE_SCRIPT:
  1055.     if (attrGroup1 > 1)
  1056.       ParseException(L"exactly one of 'src' or 'srcexpr' must be specified");
  1057.     break;
  1058.   case NODE_SUBDIALOG:
  1059.     if (attrGroup1 != 1)
  1060.       ParseException(L"exactly one of 'src' or 'srcexpr' must be specified");
  1061.     break;
  1062.   case NODE_SUBMIT:
  1063.     if (attrGroup1 != 1)
  1064.       ParseException(L"exactly one of 'next' or 'expr' must be specified");
  1065.     break;
  1066.   case NODE_THROW:
  1067.     if (attrGroup1 != 1)
  1068.       ParseException(L"exactly one of 'event' or 'eventexpr' "
  1069.                      L"must be specified");
  1070.     if (attrGroup2 > 1)
  1071.       ParseException(L"exactly one of 'message' or 'messageexpr' "
  1072.                      L"may be specified");
  1073.     break;
  1074.   case NODE_TRANSFER:
  1075.     if (attrGroup1 > 1)
  1076.       ParseException(L"exactly one of 'dest' or 'destexpr' may be specified");
  1077.     if (attrGroup2 > 1)
  1078.       ParseException(L"exactly one of 'aai' or 'aaiexpr' may be specified");
  1079.     if (attrGroup3 > 1)
  1080.       ParseException(L"exactly one of 'bridge' or 'type' may be specified");
  1081.     break;
  1082.   }
  1084.   // (6) Verify the node.
  1085.   ProcessNodeFinal(elemType);
  1086. }
  1089. void DocumentConverter::endElement(const XMLCh* const uri,
  1090.                                    const XMLCh* const localname,
  1091.                                    const XMLCh* const qname)
  1092. {
  1093.   // (0) Just ignore this?
  1094.   if (ignoreDepth > 0) {
  1095.     --ignoreDepth;
  1096.     return;
  1097.   }
  1099.   // (1) Copy this element or look it up?
  1101.   // (1.1) Inside a <grammar>, we can blindly copy this data.
  1102.   if (inGrammar && copyDepth == 0) inGrammar = false;
  1103.   if (inGrammar) {
  1104.     CopyElementClose(localname);
  1105.     return;
  1106.   }
  1108.   // (1.2) Convert name string to integer value.
  1109.   XMLChToVXIchar elementName(localname);
  1110.   int elemType;
  1111.   bool conversionFailed = !ConvertElement(elementName.c_str(), elemType);
  1113.   // (1.3) Handle elements inside a <prompt>.
  1114.   if (explicitPrompt) {
  1115.     if (conversionFailed) {
  1116.       CopyElementClose(localname);
  1117.       return;
  1118.     }
  1120.     switch (elemType) {
  1121.     // these elements don't get copied as text within a prompt
  1122.     case NODE_FOREACH:
  1123.     case NODE_AUDIO:
  1124.     case NODE_VALUE:
  1125.     case NODE_ENUMERATE:
  1126.     case NODE_MARK:
  1127.     case NODE_ASSIGN:
  1128.     case NODE_EXIT:
  1129.     case NODE_LOG:
  1130.     case NODE_IF:
  1131.     case NODE_ELSE:
  1132.     case NODE_ELSEIF:
  1133.     case NODE_CLEAR:
  1134.     case NODE_DATA:
  1135.     case NODE_DISCONNECT:
  1136.     case NODE_GOTO:
  1137.     case NODE_SUBMIT:
  1138.     case NODE_VAR:
  1139.     case NODE_RETURN:
  1140.     case NODE_SCRIPT:
  1141.     case NODE_REPROMPT:
  1142.     case NODE_THROW:
  1143.       break;
  1145.     case NODE_PROMPT:
  1146.       if (foreachImplicit) {
  1147.         return;
  1148.       }
  1150.       explicitPrompt--;
  1151.       if (explicitPrompt > 0) {
  1152.         return;
  1153.       }
  1154.       doc->AddContent(L"</speak>", 8);
  1155.       break;
  1157.     // since we are in an explicit prompt, this handles
  1158.     // closing SSML elements
  1159.     default:
  1160.       CopyElementClose(localname);
  1161.       return;
  1162.     }
  1163.   }
  1165.   // (1.4) Print errors for all other conversion failures.
  1166.   if (conversionFailed) {
  1167.     vxistring temp(L"unrecognized element - ");
  1168.     temp += elementName.c_str();
  1169.     ParseException(temp.c_str());
  1170.   }
  1172.   // (2) Check for ending of implicit prompts.
  1174.   if (implicitPrompt) {
  1175.     switch (elemType) {
  1176.     // none of these elements should end an implicit prompt
  1177.     // because we don't know what's to follow
  1178.     case NODE_AUDIO:
  1179.     case NODE_VALUE:
  1180.     case NODE_ENUMERATE:
  1181.       break;
  1183.     // These implicitly imply a prompt and the contents
  1184.     // are done converting to text
  1185.     case PRIV_ELEM_BREAK:  
  1186.     case PRIV_ELEM_EMPHASIS:
  1187.     case PRIV_ELEM_PARAGRAPH:
  1188.     case PRIV_ELEM_PHONEME:
  1189.     case PRIV_ELEM_PROSODY:
  1190.     case PRIV_ELEM_SAYAS:
  1191.     case PRIV_ELEM_SENTENCE:
  1192.     case PRIV_ELEM_VOICE:
  1193.       CopyElementClose(localname);
  1194.       return;
  1196.     // if we're in an implicit prompt and encounter a prompt element,
  1197.     // it's because we're withing a foreach... so we just ignore
  1198.     // the prompt element.
  1199. case NODE_PROMPT:
  1200. return;
  1202.     // we're out of the foreach implicit prompt
  1203.     case NODE_FOREACH:
  1204.       foreachImplicit = false;
  1205.   break;
  1207. // executable content that could be within a foreach
  1208.     case NODE_ASSIGN:
  1209.     case NODE_EXIT:
  1210.     case NODE_LOG:
  1211.     case NODE_IF:
  1212.     case NODE_ELSE:
  1213.     case NODE_ELSEIF:
  1214.     case NODE_CLEAR:
  1215.     case NODE_DATA:
  1216.     case NODE_DISCONNECT:
  1217.     case NODE_GOTO:
  1218.     case NODE_SUBMIT:
  1219.     case NODE_MARK:
  1220.     case NODE_VAR:
  1221.     case NODE_RETURN:
  1222.     case NODE_SCRIPT:
  1223.     case NODE_REPROMPT:
  1224.     case NODE_THROW:
  1225.       if (foreachImplicit)
  1226.         break;
  1227.       // fall through intentional
  1228.     default:
  1229.       EndImplicitPrompt();
  1230.       break;
  1231.     }
  1232.   }
  1234.   // (3) Reverse special handling from startElement()
  1236.   switch (elemType) {
  1237.   case NODE_CHOICE:          // These may have PCDATA which is not a prompt
  1238.   case NODE_OPTION:
  1239.     doc->PruneWhitespace();
  1240.     pcdataImpliesPrompt = true;
  1241.   case NODE_LOG:
  1242.     pcdataImpliesPrompt = true;
  1243.     break;
  1244.   case NODE_SCRIPT:
  1245.     pcdataImpliesPrompt = true;
  1246.     // Intentional fall through!
  1247.   case NODE_GRAMMAR:
  1248.     if (contentForbidden ^ hasContent)
  1249.       contentForbidden = false;
  1250.     else
  1251.       ParseException(L"either the 'src' attribute or inlined content "
  1252.                      L"may be provided, not both");
  1253.     break;
  1254.   default:
  1255.     break;
  1256.   }
  1258.   // (4) This element is complete.
  1260.   try {
  1261.     doc->EndElement();
  1262.   }
  1263.   catch (const VXMLDocumentModel::InternalError &) {
  1264.     ParseException(L"corrupted document tree; unable to complete element");
  1265.   }
  1266. }
  1269. void DocumentConverter::characters(const XMLCh* const chars,
  1270.                                    const unsigned int length)
  1271. {
  1272.   // (0) Just ignore this?
  1273.   if (chars == NULL || length == 0 || ignoreDepth > 0) return;
  1275.   // (1) Ignore non-empty prompts consisting of pure whitespace
  1276.   unsigned int l;
  1277.   for (l = 0; l < length; ++l) {
  1278.     XMLCh c = chars[l];
  1279.     if (c == ' ' || c == 'n' || c == 'r' || c == 't') continue;
  1280.     break;
  1281.   }
  1282.   if (l == length) return;
  1284.   // (2) Is this an implicit prompt?
  1285.   if (pcdataImpliesPrompt && !explicitPrompt && !implicitPrompt && !inGrammar)
  1286.     StartImplicitPrompt();
  1288.   // (3) Add content to the document model.
  1289.   try {
  1290.     XMLChToVXIchar data(chars);
  1291.     hasContent = true;
  1292.     
  1293.     if( (inGrammar && (GetGrammarType().empty() || GetGrammarType() == L"application/srgs+xml")) ||
  1294.         (explicitPrompt || implicitPrompt)
  1295.         ) 
  1296.     {
  1297.       if (!inCDATA)
  1298.         doc->AddContent(data.c_str(), wcslen(data.c_str()));
  1299.       else {
  1300.         doc->AddContent(L"<![CDATA[", 9);
  1301.         doc->AddContent(data.c_str(), wcslen(data.c_str()));
  1302.         doc->AddContent(L"]]>", 3);
  1303.       }
  1304.     } else {
  1305.       doc->AddContent(data.c_str(), wcslen(data.c_str()));
  1306.     }
  1307.   }
  1308.   catch (const VXMLDocumentModel::OutOfMemory &) {
  1309.     ParseException(L"unable to allocate memory for content");
  1310.   }
  1311.   catch (const VXMLDocumentModel::InternalError &) {
  1312.     ParseException(L"corrupted document tree; unable to add content");
  1313.   }
  1314. }
  1317. void DocumentConverter::ignorableWhitespace(const XMLCh* const chars,
  1318.                                             const unsigned int l)
  1319. { }
  1322. void DocumentConverter::processingInstruction(const XMLCh* const target,
  1323.                                               const XMLCh* const data)
  1324. { }
  1326. //#############################################################################
  1328. void DocumentConverter::ProcessNodeAttribute(VXMLElementType elemType,
  1329.                                              int attrType,
  1330.                                              const VXIchar* const value)
  1331. {
  1332.   // This shouldn't ever happen, if it does, we'll just ignore it.
  1333.   if (value == NULL) return;
  1335.   switch (elemType) {
  1336.   case NODE_BLOCK:
  1337.   case NODE_INITIAL:
  1338.     if (attrType == ATTRIBUTE_NAME)
  1339.       namedControlItems.push_back(value);
  1340.   case NODE_FIELD:
  1341.   case NODE_OBJECT:
  1342.   case NODE_RECORD:
  1343.   case NODE_TRANSFER:
  1344.     // We associate a hidden interal name with this element.
  1345.     if (attrType == ATTRIBUTE_NAME) attrType = ATTRIBUTE__ITEMNAME;
  1346.     break;
  1347.   case NODE_CLEAR:
  1348.     if (attrType == ATTRIBUTE_NAMELIST && !value[0])
  1349.       ParseException(L"the namelist attribute on clear cannot be empty");
  1350.     break;
  1351.   case NODE_FORM:
  1352.   case NODE_MENU:
  1353.     // We associate a hidden interal name with this element.
  1354.     if (attrType == ATTRIBUTE_ID) attrType = ATTRIBUTE__ITEMNAME;
  1355.     break;
  1356.   case NODE_FILLED:
  1357.     if (doc->GetParentType() != NODE_FORM)
  1358.       ParseException(L"attributes valid on filled only at form level");
  1359.     if (attrType == ATTRIBUTE_NAMELIST && !value[0])
  1360.       ParseException(L"the namelist attribute on filled cannot be empty");
  1361.     if (attrType == ATTRIBUTE_NAMELIST){
  1362.       if ( vxistring( value ) != L"any")
  1363.         filledNameList.push_back(value);
  1364.     }
  1365.     break;
  1366.   case NODE_GRAMMAR:
  1367.     if (doc->GetParentType() != NODE_FORM && attrType == ATTRIBUTE_SCOPE)
  1368.       ParseException(L"the scope attribute is valid only on grammars at form "
  1369.                      L"level");
  1370.     break;
  1371.   case NODE_SUBDIALOG:
  1372.     // We associate a hidden interal name with this element.
  1373.     if (attrType == ATTRIBUTE_NAME) attrType = ATTRIBUTE__ITEMNAME;
  1374.     // modal was dropped in 2.0.
  1375.     if (attrType == ATTRIBUTE_MODAL && version != 1.0f)
  1376.       ParseException(L"the modal attribute on subdialog was dropped after "
  1377.                      L"1.0");
  1378.     break;
  1379.   case NODE_VALUE:
  1380.     if (attrType == ATTRIBUTE_EXPR) break;
  1382.     if (doc->GetParentType() == NODE_LOG)
  1383.       ParseException(L"only the expr attribute is valid on value elements "
  1384.                      L"within a log element");
  1385.     break;
  1386.   case NODE_VXML:
  1387.     // version is processed elsewhere and may be ignored.
  1388.     if (attrType == ATTRIBUTE_VERSION) return;
  1389.     if (attrType == PRIV_ATTRIB_SCHEMALOC) return;
  1390.     break;
  1391.   default:
  1392.     break;
  1393.   }
  1395.   // (4.3) Add the attribute to the element.
  1397.   if (attrType > PRIV_ATTRIB_RangeStart)
  1398.     ParseException(L"internal error during attribute processing");
  1400.   doc->AddAttribute(VXMLAttributeType(attrType), value);
  1401. }
  1404. void DocumentConverter::ProcessNodeFinal(VXMLElementType elemType)
  1405. {
  1406.   // Convert attributes.
  1407.   vxistring attr;
  1409.   switch (elemType) {
  1410.   case NODE_BLOCK:
  1411.   case NODE_FIELD:
  1412.   case NODE_FORM:
  1413.   case NODE_INITIAL:
  1414.   case NODE_MENU:
  1415.   case NODE_OBJECT:
  1416.   case NODE_RECORD:
  1417.   case NODE_SUBDIALOG:
  1418.   case NODE_TRANSFER:
  1419.     // Name the 'unnamed' elements as neccessary.
  1420.     if (!doc->GetAttribute(ATTRIBUTE__ITEMNAME, attr)) {
  1421.       vxistring variable;
  1422.       VXMLDocumentModel::CreateHiddenVariable(variable);
  1423.       doc->AddAttribute(ATTRIBUTE__ITEMNAME, variable);
  1424.     }
  1425.     break;
  1426.   case NODE_FILLED:
  1427.     if (!doc->GetAttribute(ATTRIBUTE_MODE, attr))
  1428.       doc->AddAttribute(ATTRIBUTE_MODE, L"all");
  1429.     break;
  1430.   case NODE_VXML:
  1431.   case DEFAULTS_ROOT:
  1432.     VXMLDocumentModel::CreateHiddenVariable(attr);
  1433.     doc->AddAttribute(ATTRIBUTE__ITEMNAME, attr);
  1434.     break;
  1435.   default:
  1436.     break;
  1437.   }
  1439.   // Generate DTMF sequences for <choice> elements in <menu> if necessary.
  1440.   if (elemType == NODE_MENU) {
  1441.     if (doc->GetAttribute(ATTRIBUTE_DTMF, attr) && attr == L"true")
  1442.       choiceNumber = 1;
  1443.     else
  1444.       choiceNumber = 0;
  1445.   }
  1447.   if (elemType == NODE_CHOICE && choiceNumber > 0 && choiceNumber < 10 &&
  1448.       !doc->GetAttribute(ATTRIBUTE_DTMF, attr))
  1449.   {
  1450.     std::basic_stringstream<VXIchar> countString;
  1451.     countString << choiceNumber;
  1452.     doc->AddAttribute(ATTRIBUTE_DTMF, countString.str());
  1453.     ++choiceNumber;
  1454.   }
  1456.   if (elemType == NODE_PROMPT) {
  1457.     vxistring base, lang;
  1458.     doc->GetAttribute(ATTRIBUTE_BASE, base);
  1459.     doc->GetAttribute(ATTRIBUTE_XMLLANG, lang);
  1460.     // remove all irrelavant part from the base uri
  1461.     TrimUriBase(base);
  1462.     
  1463.     doc->AddContent(L"<?xml version='1.0'?><speak version='1.0' xmlns="
  1464.                     L"'http://www.w3.org/2001/10/synthesis' xml:base='", 96);
  1465.     doc->AddContent(base.c_str(), base.length());
  1466.     doc->AddContent(L"' xml:lang='", 12);
  1467.     doc->AddContent(lang.c_str(), lang.length());
  1468.     doc->AddContent(L"'>", 2);
  1469.     doc->MarkSSMLHeader();
  1470.   }
  1471. }
  1474. void DocumentConverter::CopyElementStart(const XMLCh* const localname,
  1475.                                          const Attributes &attrs)
  1476. {
  1477.   ++copyDepth;
  1479.   doc->AddContent(L"<", 1);
  1481.   XMLChToVXIchar data(localname);
  1482.   doc->AddContent(data.c_str(), wcslen(data.c_str()));
  1484.   for (unsigned int index = 0; index < attrs.getLength(); ++index) {
  1485.     doc->AddContent(L" ", 1);
  1487.     // Determine the attribute name
  1488.     if (Compare(attrs.getQName(index), L"xml:lang"))
  1489.       doc->AddContent(L"xml:lang", 8); 
  1490.     else {
  1491.       XMLChToVXIchar name(attrs.getLocalName(index));
  1492.       doc->AddContent(name.c_str(), wcslen(name.c_str()));
  1493.     }
  1494.       
  1495.     doc->AddContent(L"="", 2);
  1497.     XMLChToVXIchar value(attrs.getValue(index));
  1499.     unsigned int start = 0;
  1500.     unsigned int pos = 0;
  1501.     VXIchar c;
  1502.     // We need to escape three characters: (<,>,&) -> (&lt;,&gt;,&amp;)
  1503.     do {
  1504.       c = *(value.c_str() + pos);
  1505.       if (c == L'<') {
  1506.         if (start != pos)
  1507.            doc->AddContent(value.c_str() + start, pos - start);
  1508.         start = pos + 1;
  1509.         doc->AddContent(L"&lt;", 4);
  1510.       }
  1511.       else if (c == L'>') {
  1512.         if (start != pos)
  1513.            doc->AddContent(value.c_str() + start, pos - start);
  1514.         start = pos + 1;
  1515.         doc->AddContent(L"&gt;", 4);
  1516.       }
  1517.       else if (c == L'&') {
  1518.         if (start != pos)
  1519.            doc->AddContent(value.c_str() + start, pos - start);
  1520.         start = pos + 1;
  1521.         doc->AddContent(L"&amp;", 5);
  1522.       }
  1523.       
  1524.       ++pos;
  1525.     } while (c != L'');
  1527.     if (pos > start)
  1528.       doc->AddContent(value.c_str() + start, pos - start - 1); // -1 to kill off final 
  1530.     doc->AddContent(L""", 1);
  1531.   }
  1533.   doc->AddContent(L">", 1);
  1534. }
  1537. void DocumentConverter::CopyElementClose(const XMLCh* const localname)
  1538. {
  1539.   doc->AddContent(L"</", 2);
  1541.   XMLChToVXIchar data(localname);
  1542.   doc->AddContent(data.c_str(), wcslen(data.c_str()));
  1544.   doc->AddContent(L">", 1);
  1546.   --copyDepth;
  1547. }
  1550. void DocumentConverter::StartImplicitPrompt()
  1551. {
  1552.   implicitPrompt = true;
  1553.   doc->StartElement(NODE_PROMPT, documentLevel);
  1554.   
  1555.   vxistring tmpBaseUri = baseUri;
  1556.   TrimUriBase(tmpBaseUri);
  1557.   doc->AddContent(L"<?xml version='1.0'?><speak version='1.0' xmlns="
  1558.                   L"'http://www.w3.org/2001/10/synthesis' xml:base='", 96);
  1559.   doc->AddContent(tmpBaseUri.c_str(), tmpBaseUri.length());
  1560.   doc->AddContent(L"' xml:lang='", 12);
  1561.   doc->AddContent(documentLang.c_str(), documentLang.length());
  1562.   doc->AddContent(L"'>", 2);
  1563.   doc->MarkSSMLHeader();
  1564.   
  1565.   copyDepth = 0;
  1566. }
  1569. void DocumentConverter::EndImplicitPrompt()
  1570. {
  1571.   doc->AddContent(L"</speak>", 8);
  1572.   doc->EndElement();
  1573.   implicitPrompt = false;
  1574.   foreachImplicit = false;
  1575. }
  1579. void DocumentConverter::comment( const XMLCh* const chars, const unsigned int length )
  1580. {
  1581. }
  1583. void DocumentConverter::startCDATA ()
  1584. {
  1585.   inCDATA = true;
  1586. }
  1588. void DocumentConverter::endCDATA ()
  1589. {
  1590.   inCDATA = false;
  1591. }
  1593. void DocumentConverter::startEntity (const XMLCh* const name)
  1594. {
  1595. }
  1597. void DocumentConverter::endEntity (const XMLCh* const name)
  1598. {
  1599. }
  1601. void DocumentConverter::startDTD
  1602. (
  1603.     const   XMLCh* const    name
  1604.     , const   XMLCh* const    publicId
  1605.     , const   XMLCh* const    systemId
  1606. )
  1607. {
  1608. }
  1610. void DocumentConverter::endDTD ()
  1611. {
  1612. }