autodoc/source/display/idl/hi_linkhelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef ADC_DISPLAY_HI_LINKHELPER_HXX
  30 #define ADC_DISPLAY_HI_LINKHELPER_HXX
  31
  32
  33 // USED SERVICES
  34     // BASE CLASSES
  35     // COMPONENTS
  36     // PARAMETERS
  37 #include "hi_ary.hxx"
  38 #include "hi_env.hxx"
  39 #include <toolkit/out_position.hxx>
  40 #include <toolkit/out_tree.hxx>
  41
  42
  43 class LinkHelper
  44 {
  45   public:
  46     typedef ary::idl::CodeEntity                CE;
  47     typedef output::Position                    OutPosition;
  48
  49                         LinkHelper(
  50                             HtmlEnvironment_Idl &
  51                                                 io_rEnv )
  52                             :   rEnv(io_rEnv) {}
  53
  54     OutPosition         PositionOf_CurModule() const
  55                         { return OutPosition( rEnv.CurPosition(),
  56                                               output::ModuleFileName()); }
  57
  58     OutPosition         PositionOf_CurXRefs(
  59                             const String &      i_ceName) const;
  60     OutPosition         PositionOf_Index() const
  61                         { OutPosition ret1 = rEnv.OutputTree().IndexRoot();
  62                           return OutPosition( ret1, String(output::IndexFile_A()) ); }
  63
  64
  65     const ary::idl::Module *
  66                         Search_CurModule() const;
  67     const ary::idl::Module *
  68                         Search_Module(
  69                             output::Node &      i_node ) const;
  70
  71     const CE *          Search_CeFromType(
  72                             ary::idl::Type_id   i_type ) const;
  73
  74     void                Get_Link2Position(
  75                             StreamStr &         o_link,
  76                             OutPosition &       i_pos ) const
  77                         { rEnv.CurPosition().Get_LinkTo(o_link, i_pos); }
  78
  79     void                Get_Link2Member(
  80                             StreamStr &         o_link,
  81                             OutPosition &       i_ownerPos,
  82                             const String &      i_memberName ) const
  83                         { Get_Link2Position(o_link, i_ownerPos);
  84                           o_link << "#" << i_memberName; }
  85     const String &      XrefsSuffix() const;
  86
  87   private:
  88     HtmlEnvironment_Idl & rEnv;
  89 };
  90
  91 inline const ary::idl::CodeEntity *
  92 LinkHelper::Search_CeFromType( ary::idl::Type_id i_type ) const
  93 {
  94     ary::idl::Ce_id nCe = rEnv.Data().CeFromType(i_type);
  95     if (nCe.IsValid())
  96         return &rEnv.Data().Find_Ce(nCe);
  97     return 0;
  98 }
  99
 100
 101
 102 String              nameChainLinker(
 103                         const char *        i_levelName );
 104
 105
 106 #endif
 107
 108 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */