framework/source/xml/acceleratorconfigurationwriter.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21
  22 #include <accelerators/keymapping.hxx>
  23 #include <utility>
  24 #include <xml/acceleratorconfigurationwriter.hxx>
  25
  26 #include <acceleratorconst.h>
  27
  28 #include <com/sun/star/xml/sax/XExtendedDocumentHandler.hpp>
  29 #include <com/sun/star/awt/KeyModifier.hpp>
  30
  31 #include <comphelper/attributelist.hxx>
  32 #include <rtl/ref.hxx>
  33
  34 namespace framework{
  35
  36 AcceleratorConfigurationWriter::AcceleratorConfigurationWriter(const AcceleratorCache&                                       rContainer,
  37                                                                css::uno::Reference< css::xml::sax::XDocumentHandler >  xConfig   )
  38     : m_xConfig     (std::move(xConfig                      ))
  39     , m_rContainer  (rContainer                   )
  40 {
  41 }
  42
  43 AcceleratorConfigurationWriter::~AcceleratorConfigurationWriter()
  44 {
  45 }
  46
  47 void AcceleratorConfigurationWriter::flush()
  48 {
  49     css::uno::Reference< css::xml::sax::XExtendedDocumentHandler > xExtendedCFG(m_xConfig, css::uno::UNO_QUERY_THROW);
  50
  51     // prepare attribute list
  52     rtl::Reference<::comphelper::AttributeList> pAttribs = new ::comphelper::AttributeList;
  53
  54     pAttribs->AddAttribute(
  55         u"xmlns:accel"_ustr,
  56         u"http://openoffice.org/2001/accel"_ustr);
  57     pAttribs->AddAttribute(
  58         u"xmlns:xlink"_ustr, u"http://www.w3.org/1999/xlink"_ustr);
  59
  60     // generate xml
  61     xExtendedCFG->startDocument();
  62
  63     xExtendedCFG->unknown(
  64         u"<!DOCTYPE accel:acceleratorlist PUBLIC \"-//OpenOffice.org//DTD"
  65         " OfficeDocument 1.0//EN\" \"accelerator.dtd\">"_ustr);
  66     xExtendedCFG->ignorableWhitespace(OUString());
  67
  68     xExtendedCFG->startElement(AL_ELEMENT_ACCELERATORLIST, pAttribs);
  69     xExtendedCFG->ignorableWhitespace(OUString());
  70
  71     // TODO think about threadsafe using of cache
  72     AcceleratorCache::TKeyList                 lKeys = m_rContainer.getAllKeys();
  73     for (auto const& lKey : lKeys)
  74     {
  75         const OUString aCommand = m_rContainer.getCommandByKey(lKey);
  76         impl_ts_writeKeyCommandPair(lKey, aCommand, xExtendedCFG);
  77     }
  78
  79     /* TODO write key-command list
  80     for (auto const& writeAccelerator : m_aWriteAcceleratorList)
  81         WriteAcceleratorItem(writeAccelerator);
  82     */
  83
  84     xExtendedCFG->ignorableWhitespace(OUString());
  85     xExtendedCFG->endElement(AL_ELEMENT_ACCELERATORLIST);
  86     xExtendedCFG->ignorableWhitespace(OUString());
  87     xExtendedCFG->endDocument();
  88 }
  89
  90 // static
  91 void AcceleratorConfigurationWriter::impl_ts_writeKeyCommandPair(const css::awt::KeyEvent&                                     aKey    ,
  92                                                                  const OUString&                                        sCommand,
  93                                                                  const css::uno::Reference< css::xml::sax::XDocumentHandler >& xConfig )
  94 {
  95     rtl::Reference<::comphelper::AttributeList> pAttribs = new ::comphelper::AttributeList;
  96
  97     OUString sKey = KeyMapping::get().mapCodeToIdentifier(aKey.KeyCode);
  98     // TODO check if key is empty!
  99
 100     pAttribs->AddAttribute(u"accel:code"_ustr, sKey    );
 101     pAttribs->AddAttribute(u"xlink:href"_ustr, sCommand);
 102
 103     if ((aKey.Modifiers & css::awt::KeyModifier::SHIFT) == css::awt::KeyModifier::SHIFT)
 104         pAttribs->AddAttribute(u"accel:shift"_ustr, u"true"_ustr);
 105
 106     if ((aKey.Modifiers & css::awt::KeyModifier::MOD1) == css::awt::KeyModifier::MOD1)
 107         pAttribs->AddAttribute(u"accel:mod1"_ustr, u"true"_ustr);
 108
 109     if ((aKey.Modifiers & css::awt::KeyModifier::MOD2) == css::awt::KeyModifier::MOD2)
 110         pAttribs->AddAttribute(u"accel:mod2"_ustr, u"true"_ustr);
 111
 112     if ((aKey.Modifiers & css::awt::KeyModifier::MOD3) == css::awt::KeyModifier::MOD3)
 113         pAttribs->AddAttribute(u"accel:mod3"_ustr, u"true"_ustr);
 114
 115     xConfig->ignorableWhitespace(OUString());
 116     xConfig->startElement(AL_ELEMENT_ITEM, pAttribs);
 117     xConfig->ignorableWhitespace(OUString());
 118     xConfig->endElement(AL_ELEMENT_ITEM);
 119     xConfig->ignorableWhitespace(OUString());
 120 }
 121
 122 } // namespace framework
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */