extensions/source/ole/jscriptclasses.hxx

   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 #ifndef JSCRIPTCLASSES_HXX
  21 #define JSCRIPTCLASSES_HXX
  22
  23 #include <wincrap.hxx>
  24
  25 #pragma warning (disable:4505)
  26     // disable "unreferenced local function has been removed" globally
  27
  28 #include "comifaces.hxx"
  29
  30
  31
  32 // Sequences are represented by prepending "[]", e.g. []char, [][]byte, [][][]object, etc.
  33
  34 // To make a JScriptValue object to an out parameter, call
  35 // "InitOutParam" and to make it a in/out parameter call
  36 // "InitInOutParam"
  37
  38 // If the object represents an out parameter then the value can after the call
  39 // be retrived by "Get".
  40
  41 // From JavaScript the functions Get, Set, InitOutParam and InitInOutParam are
  42 // used, that is they are accessible through IDispatch. The functions are used
  43 // by the bridge.
  44
  45 class JScriptValue:
  46       public CComObjectRootEx<CComMultiThreadModel>,
  47       public IJScriptValueObject,
  48       public IDispatch
  49 {
  50 public:
  51     JScriptValue();
  52     virtual ~JScriptValue();
  53
  54     BEGIN_COM_MAP(JScriptValue)
  55         COM_INTERFACE_ENTRY(IDispatch)
  56         COM_INTERFACE_ENTRY(IJScriptValueObject)
  57     END_COM_MAP()
  58
  59     // IDispatch -------------------------------------------
  60     STDMETHOD( GetTypeInfoCount)(UINT *pctinfo);
  61
  62     STDMETHOD( GetTypeInfo)( UINT iTInfo,
  63                              LCID lcid,
  64                              ITypeInfo **ppTInfo);
  65
  66     STDMETHOD( GetIDsOfNames)( REFIID riid,
  67                                LPOLESTR *rgszNames,
  68                                UINT cNames,
  69                                LCID lcid,
  70                                DISPID *rgDispId);
  71
  72     STDMETHOD( Invoke)( DISPID dispIdMember,
  73                         REFIID riid,
  74                         LCID lcid,
  75                         WORD wFlags,
  76                         DISPPARAMS *pDispParams,
  77                         VARIANT *pVarResult,
  78                         EXCEPINFO *pExcepInfo,
  79                         UINT *puArgErr);
  80     // IJScriptOutParam --------------------------------------
  81
  82     STDMETHOD( Set)( VARIANT type, VARIANT value);
  83     STDMETHOD( Get)( VARIANT *val);
  84     STDMETHOD( InitOutParam)();
  85     STDMETHOD( InitInOutParam)( VARIANT type, VARIANT value);
  86     STDMETHOD( IsOutParam)( VARIANT_BOOL * flag);
  87     STDMETHOD( IsInOutParam)( VARIANT_BOOL * flag);
  88     STDMETHOD( GetValue)( BSTR* type, VARIANT *value);
  89
  90
  91     CComVariant m_varValue;
  92     CComBSTR m_bstrType;
  93     unsigned m_bOutParam: 1;
  94     unsigned m_bInOutParam: 1;
  95
  96 };
  97
  98 // If a class is implemented in JScript, then its method
  99 class JScriptOutParam:
 100       public CComObjectRootEx<CComMultiThreadModel>,
 101       public IDispatch
 102 {
 103 public:
 104     JScriptOutParam();
 105     virtual ~JScriptOutParam();
 106
 107     BEGIN_COM_MAP(JScriptOutParam)
 108         COM_INTERFACE_ENTRY(IDispatch)
 109     END_COM_MAP()
 110
 111     // IDispatch -------------------------------------------
 112     STDMETHOD( GetTypeInfoCount)(UINT *pctinfo);
 113
 114     STDMETHOD( GetTypeInfo)( UINT iTInfo,
 115                              LCID lcid,
 116                              ITypeInfo **ppTInfo);
 117
 118     STDMETHOD( GetIDsOfNames)( REFIID riid,
 119                                LPOLESTR *rgszNames,
 120                                UINT cNames,
 121                                LCID lcid,
 122                                DISPID *rgDispId);
 123
 124     STDMETHOD( Invoke)( DISPID dispIdMember,
 125                         REFIID riid,
 126                         LCID lcid,
 127                         WORD wFlags,
 128                         DISPPARAMS *pDispParams,
 129                         VARIANT *pVarResult,
 130                         EXCEPINFO *pExcepInfo,
 131                         UINT *puArgErr);
 132
 133
 134 private:
 135     CComVariant m_varValue;
 136 };
 137
 138 #endif
 139
 140 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */