303 lines
11 KiB
C++
303 lines
11 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* This file is part of the LibreOffice project.
|
|
*
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
*
|
|
* This file incorporates work covered by the following license notice:
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed
|
|
* with this work for additional information regarding copyright
|
|
* ownership. The ASF licenses this file to you under the Apache
|
|
* License, Version 2.0 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
|
|
*/
|
|
|
|
#include <xml/acceleratorconfigurationreader.hxx>
|
|
|
|
#include <acceleratorconst.h>
|
|
|
|
#include <com/sun/star/xml/sax/XExtendedDocumentHandler.hpp>
|
|
#include <com/sun/star/awt/KeyModifier.hpp>
|
|
#include <com/sun/star/awt/KeyEvent.hpp>
|
|
#include <com/sun/star/awt/Key.hpp>
|
|
#include <com/sun/star/container/ElementExistException.hpp>
|
|
|
|
#include <vcl/svapp.hxx>
|
|
#include <rtl/ustrbuf.hxx>
|
|
|
|
|
|
namespace framework{
|
|
|
|
//-----------------------------------------------
|
|
/* Throws a SaxException in case a wrong formated XML
|
|
structure was detected.
|
|
|
|
This macro combined the given comment with a generic
|
|
way to find out the XML line (where the error occurred)
|
|
to format a suitable message.
|
|
|
|
@param COMMENT
|
|
an ascii string, which describe the problem.
|
|
*/
|
|
#define THROW_PARSEEXCEPTION(COMMENT) \
|
|
{ \
|
|
OUStringBuffer sMessage(256); \
|
|
sMessage.append (implts_getErrorLineString()); \
|
|
sMessage.appendAscii(COMMENT ); \
|
|
\
|
|
throw css::xml::sax::SAXException( \
|
|
sMessage.makeStringAndClear(), \
|
|
static_cast< css::xml::sax::XDocumentHandler* >(this), \
|
|
css::uno::Any()); \
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
AcceleratorConfigurationReader::AcceleratorConfigurationReader(AcceleratorCache& rContainer)
|
|
: ThreadHelpBase (&Application::GetSolarMutex())
|
|
, m_rContainer (rContainer )
|
|
, m_bInsideAcceleratorList(sal_False )
|
|
, m_bInsideAcceleratorItem(sal_False )
|
|
{
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
AcceleratorConfigurationReader::~AcceleratorConfigurationReader()
|
|
{
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
void SAL_CALL AcceleratorConfigurationReader::startDocument()
|
|
throw(css::xml::sax::SAXException,
|
|
css::uno::RuntimeException )
|
|
{
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
void SAL_CALL AcceleratorConfigurationReader::endDocument()
|
|
throw(css::xml::sax::SAXException,
|
|
css::uno::RuntimeException )
|
|
{
|
|
// The xml file seems to be corrupted.
|
|
// Because we found no end-tags ... at least for
|
|
// one list or item.
|
|
if (
|
|
(m_bInsideAcceleratorList) ||
|
|
(m_bInsideAcceleratorItem)
|
|
)
|
|
{
|
|
THROW_PARSEEXCEPTION("No matching start or end element 'acceleratorlist' found!")
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
void SAL_CALL AcceleratorConfigurationReader::startElement(const OUString& sElement ,
|
|
const css::uno::Reference< css::xml::sax::XAttributeList >& xAttributeList)
|
|
throw(css::xml::sax::SAXException,
|
|
css::uno::RuntimeException )
|
|
{
|
|
EXMLElement eElement = AcceleratorConfigurationReader::implst_classifyElement(sElement);
|
|
|
|
// Note: We handle "accel:item" before "accel:acceleratorlist" to perform this operation.
|
|
// Because an item occurs very often ... a list should occur one times only!
|
|
if (eElement == E_ELEMENT_ITEM)
|
|
{
|
|
if (!m_bInsideAcceleratorList)
|
|
THROW_PARSEEXCEPTION("An element \"accel:item\" must be embeded into 'accel:acceleratorlist'.")
|
|
if (m_bInsideAcceleratorItem)
|
|
THROW_PARSEEXCEPTION("An element \"accel:item\" is not a container.")
|
|
m_bInsideAcceleratorItem = sal_True;
|
|
|
|
OUString sCommand;
|
|
css::awt::KeyEvent aEvent ;
|
|
|
|
sal_Int16 c = xAttributeList->getLength();
|
|
sal_Int16 i = 0;
|
|
for (i=0; i<c; ++i)
|
|
{
|
|
OUString sAttribute = xAttributeList->getNameByIndex(i);
|
|
OUString sValue = xAttributeList->getValueByIndex(i);
|
|
EXMLAttribute eAttribute = AcceleratorConfigurationReader::implst_classifyAttribute(sAttribute);
|
|
switch(eAttribute)
|
|
{
|
|
case E_ATTRIBUTE_URL :
|
|
sCommand = sValue.intern();
|
|
break;
|
|
|
|
case E_ATTRIBUTE_KEYCODE :
|
|
aEvent.KeyCode = m_rKeyMapping->mapIdentifierToCode(sValue);
|
|
break;
|
|
|
|
case E_ATTRIBUTE_MOD_SHIFT :
|
|
aEvent.Modifiers |= css::awt::KeyModifier::SHIFT;
|
|
break;
|
|
|
|
case E_ATTRIBUTE_MOD_MOD1 :
|
|
aEvent.Modifiers |= css::awt::KeyModifier::MOD1;
|
|
break;
|
|
|
|
case E_ATTRIBUTE_MOD_MOD2 :
|
|
aEvent.Modifiers |= css::awt::KeyModifier::MOD2;
|
|
break;
|
|
|
|
case E_ATTRIBUTE_MOD_MOD3 :
|
|
aEvent.Modifiers |= css::awt::KeyModifier::MOD3;
|
|
}
|
|
}
|
|
|
|
// validate command and key event.
|
|
if (
|
|
sCommand.isEmpty() ||
|
|
(aEvent.KeyCode == 0 )
|
|
)
|
|
{
|
|
THROW_PARSEEXCEPTION("XML element does not describe a valid accelerator nor a valid command.")
|
|
}
|
|
|
|
// register key event + command inside cache ...
|
|
// Check for already existing items there.
|
|
if (!m_rContainer.hasKey(aEvent))
|
|
m_rContainer.setKeyCommandPair(aEvent, sCommand);
|
|
else
|
|
{
|
|
// Attention: Its not really a reason to throw an exception and kill the office, if the configuration contains
|
|
// multiple registrations for the same key :-) Show a warning ... and ignore the second item.
|
|
// THROW_PARSEEXCEPTION("Command is registered for the same key more then once.")
|
|
SAL_INFO("fwk",
|
|
"AcceleratorConfigurationReader::startElement(): Double registration detected. Command=\"" <<
|
|
sCommand <<
|
|
"\" KeyCode=" <<
|
|
aEvent.KeyCode <<
|
|
"Modifiers=" <<
|
|
aEvent.Modifiers);
|
|
}
|
|
}
|
|
|
|
if (eElement == E_ELEMENT_ACCELERATORLIST)
|
|
{
|
|
if (m_bInsideAcceleratorList)
|
|
THROW_PARSEEXCEPTION("An element \"accel:acceleratorlist\" cannot be used recursive.")
|
|
m_bInsideAcceleratorList = sal_True;
|
|
return;
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
void SAL_CALL AcceleratorConfigurationReader::endElement(const OUString& sElement)
|
|
throw(css::xml::sax::SAXException,
|
|
css::uno::RuntimeException )
|
|
{
|
|
EXMLElement eElement = AcceleratorConfigurationReader::implst_classifyElement(sElement);
|
|
|
|
// Note: We handle "accel:item" before "accel:acceleratorlist" to perform this operation.
|
|
// Because an item occurs very often ... a list should occur one times only!
|
|
if (eElement == E_ELEMENT_ITEM)
|
|
{
|
|
if (!m_bInsideAcceleratorItem)
|
|
THROW_PARSEEXCEPTION("Found end element 'accel:item', but no start element.")
|
|
m_bInsideAcceleratorItem = sal_False;
|
|
}
|
|
|
|
if (eElement == E_ELEMENT_ACCELERATORLIST)
|
|
{
|
|
if (!m_bInsideAcceleratorList)
|
|
THROW_PARSEEXCEPTION("Found end element 'accel:acceleratorlist', but no start element.")
|
|
m_bInsideAcceleratorList = sal_False;
|
|
}
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
void SAL_CALL AcceleratorConfigurationReader::characters(const OUString&)
|
|
throw(css::xml::sax::SAXException,
|
|
css::uno::RuntimeException )
|
|
{
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
void SAL_CALL AcceleratorConfigurationReader::ignorableWhitespace(const OUString&)
|
|
throw(css::xml::sax::SAXException,
|
|
css::uno::RuntimeException )
|
|
{
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
void SAL_CALL AcceleratorConfigurationReader::processingInstruction(const OUString& /*sTarget*/,
|
|
const OUString& /*sData*/ )
|
|
throw(css::xml::sax::SAXException,
|
|
css::uno::RuntimeException )
|
|
{
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
void SAL_CALL AcceleratorConfigurationReader::setDocumentLocator(const css::uno::Reference< css::xml::sax::XLocator >& xLocator)
|
|
throw(css::xml::sax::SAXException,
|
|
css::uno::RuntimeException )
|
|
{
|
|
m_xLocator = xLocator;
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
AcceleratorConfigurationReader::EXMLElement AcceleratorConfigurationReader::implst_classifyElement(const OUString& sElement)
|
|
{
|
|
AcceleratorConfigurationReader::EXMLElement eElement;
|
|
|
|
if (sElement.equals(NS_ELEMENT_ACCELERATORLIST))
|
|
eElement = E_ELEMENT_ACCELERATORLIST;
|
|
else if (sElement.equals(NS_ELEMENT_ITEM))
|
|
eElement = E_ELEMENT_ITEM;
|
|
else
|
|
throw css::uno::RuntimeException(
|
|
"Unknown XML element detected!",
|
|
css::uno::Reference< css::xml::sax::XDocumentHandler >());
|
|
|
|
return eElement;
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
AcceleratorConfigurationReader::EXMLAttribute AcceleratorConfigurationReader::implst_classifyAttribute(const OUString& sAttribute)
|
|
{
|
|
AcceleratorConfigurationReader::EXMLAttribute eAttribute;
|
|
|
|
if (sAttribute.equals(NS_ATTRIBUTE_KEYCODE))
|
|
eAttribute = E_ATTRIBUTE_KEYCODE;
|
|
else if (sAttribute.equals(NS_ATTRIBUTE_MOD_SHIFT))
|
|
eAttribute = E_ATTRIBUTE_MOD_SHIFT;
|
|
else if (sAttribute.equals(NS_ATTRIBUTE_MOD_MOD1))
|
|
eAttribute = E_ATTRIBUTE_MOD_MOD1;
|
|
else if (sAttribute.equals(NS_ATTRIBUTE_MOD_MOD2))
|
|
eAttribute = E_ATTRIBUTE_MOD_MOD2;
|
|
else if (sAttribute.equals(NS_ATTRIBUTE_MOD_MOD3))
|
|
eAttribute = E_ATTRIBUTE_MOD_MOD3;
|
|
else if (sAttribute.equals(NS_ATTRIBUTE_URL))
|
|
eAttribute = E_ATTRIBUTE_URL;
|
|
else
|
|
throw css::uno::RuntimeException(
|
|
"Unknown XML attribute detected!",
|
|
css::uno::Reference< css::xml::sax::XDocumentHandler >());
|
|
|
|
return eAttribute;
|
|
}
|
|
|
|
//-----------------------------------------------
|
|
OUString AcceleratorConfigurationReader::implts_getErrorLineString()
|
|
{
|
|
if (!m_xLocator.is())
|
|
return OUString("Error during parsing XML. (No further info available ...)");
|
|
|
|
OUStringBuffer sMsg(256);
|
|
sMsg.appendAscii("Error during parsing XML in\nline = ");
|
|
sMsg.append (m_xLocator->getLineNumber() );
|
|
sMsg.appendAscii("\ncolumn = " );
|
|
sMsg.append (m_xLocator->getColumnNumber() );
|
|
sMsg.appendAscii("." );
|
|
return sMsg.makeStringAndClear();
|
|
}
|
|
|
|
} // namespace framework
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|