udkapi/com/sun/star/script/ContextInformation.idl

   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 #ifndef __com_sun_star_script_ContextInformation_idl__
  20 #define __com_sun_star_script_ContextInformation_idl__
  21
  22
  23
  24  module com {  module sun {  module star {  module script {
  25
  26 /** provides information about a certain stack frame.
  27
  28     @deprecated
  29  */
  30 published struct ContextInformation
  31 {
  32     /** Full qualified name to address the module or function associated with the context.
  33         If the module or function can't be addressed by name, e.g., in case that a runtime
  34         generated eval-module is executed, this string is empty
  35      */
  36     string Name;
  37
  38     /** Source code of the Module, that is associated with the context. If the source can
  39         be accessed using the ModuleName or if the source is unknown (executing compiled
  40         code) this string can be empty.
  41      */
  42     string SourceCode;
  43
  44     /** contains the first line in the module's source code associated with
  45         the context.
  46
  47         <p>If "name" addresses a function, all line and column values
  48         are nevertheless given relative to the module's source. If
  49         source code is not available, this value addresses a binary
  50         position in the compiled code.  </p>
  51
  52         @see XLibraryAccess::getModuleCode
  53         @see XLibraryAccess::getFunctionCode
  54      */
  55     long StartLine;
  56
  57     /** contains the first column in the <var>StartLine</var> associated with
  58         the context.
  59      */
  60     long StartColumn;
  61
  62
  63     /** contains the last line in the module's source code associated with
  64         the context.
  65      */
  66     long EndLine;
  67
  68     /** contains the first column in the <var>EndLine</var> that is NOT
  69         associated with the context.
  70      */
  71     long EndColumn;
  72
  73     /** Get all names of the local variable in this context.
  74      */
  75     sequence<string> LocalVariableNames;
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */