autodoc/source/display/idl/hfi_property.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 <precomp.h>
  21 #include "hfi_property.hxx"
  22
  23
  24 // NOT FULLY DEFINED SERVICES
  25 #include <ary/idl/i_ce.hxx>
  26 #include <ary/idl/ik_attribute.hxx>
  27 #include <ary/idl/ik_constant.hxx>
  28 #include <ary/idl/ik_enumvalue.hxx>
  29 #include <ary/idl/ik_property.hxx>
  30 #include <ary/idl/ik_structelem.hxx>
  31 #include <toolkit/hf_docentry.hxx>
  32 #include <toolkit/hf_title.hxx>
  33 #include "hfi_typetext.hxx"
  34 #include "hfi_doc.hxx"
  35 #include "hfi_tag.hxx"
  36 #include "hi_env.hxx"
  37 #include "hi_ary.hxx"
  38 #include "hi_linkhelper.hxx"
  39
  40 void
  41 HF_IdlDataMember::Produce_byData( const client & ce ) const
  42 {
  43     write_Title(ce);
  44     enter_ContentCell();
  45     write_Declaration(ce);
  46     write_Description(ce);
  47     leave_ContentCell();
  48 }
  49
  50 HF_IdlDataMember::HF_IdlDataMember( Environment &       io_rEnv,
  51                                     HF_SubTitleTable &  o_table )
  52     :   HtmlFactory_Idl( io_rEnv,
  53                          &(o_table.Add_Row()
  54                             >> *new Html::TableCell
  55                                 << new Html::ClassAttr(C_sCellStyle_MDetail))
  56                        )
  57 {
  58 }
  59
  60 const String sContentBorder("0");
  61 const String sContentWidth("96%");
  62 const String sContentPadding("5");
  63 const String sContentSpacing("0");
  64
  65 const String sBgWhite("#ffffff");
  66 const String sCenter("center");
  67
  68 void
  69 HF_IdlDataMember::write_Title( const client & i_ce ) const
  70 {
  71     CurOut()
  72         >> *new Html::Label(i_ce.LocalName())
  73             << new Html::ClassAttr(C_sMemberTitle)
  74             << i_ce.LocalName();
  75 }
  76
  77 void
  78 HF_IdlDataMember::write_Description( const client & i_ce ) const
  79 {
  80     CurOut() << new Html::HorizontalLine;
  81     write_Docu(CurOut(), i_ce);
  82 }
  83
  84 void
  85 HF_IdlDataMember::enter_ContentCell() const
  86 {
  87
  88     Xml::Element &
  89         rContentCell = CurOut()
  90                         >> *new Html::Table( sContentBorder,
  91                                              sContentWidth,
  92                                              sContentPadding,
  93                                              sContentSpacing )
  94                             << new Html::ClassAttr("table-in-data")
  95                             << new Html::BgColorAttr(sBgWhite)
  96                             << new Html::AlignAttr(sCenter)
  97                             >> *new Html::TableRow
  98                                 >> *new Html::TableCell;
  99     Out().Enter(rContentCell);
 100 }
 101
 102
 103 void
 104 HF_IdlDataMember::leave_ContentCell() const
 105 {
 106     Out().Leave();
 107 }
 108
 109
 110 HF_IdlProperty::~HF_IdlProperty()
 111 {
 112 }
 113
 114 typedef ary::idl::ifc_property::attr    PropertyAttr;
 115
 116 void
 117 HF_IdlProperty::write_Declaration( const client & i_ce ) const
 118 {
 119     if (PropertyAttr::HasAnyStereotype(i_ce))
 120     {
 121         CurOut() << "[ ";
 122         if (PropertyAttr::IsReadOnly(i_ce))
 123             CurOut() << "readonly ";
 124         if (PropertyAttr::IsBound(i_ce))
 125             CurOut() << "bound ";
 126         if (PropertyAttr::IsConstrained(i_ce))
 127             CurOut() << "constrained ";
 128         if (PropertyAttr::IsMayBeAmbiguous(i_ce))
 129             CurOut() << "maybeambiguous ";
 130         if (PropertyAttr::IsMayBeDefault(i_ce))
 131             CurOut() << "maybedefault ";
 132         if (PropertyAttr::IsMayBeVoid(i_ce))
 133             CurOut() << "maybevoid ";
 134         if (PropertyAttr::IsRemovable(i_ce))
 135             CurOut() << "removable ";
 136         if (PropertyAttr::IsTransient(i_ce))
 137             CurOut() << "transient ";
 138         CurOut() << "] ";
 139     }   // end if
 140
 141     HF_IdlTypeText
 142         aType( Env(), CurOut() );
 143     aType.Produce_byData( PropertyAttr::Type(i_ce) );
 144
 145     CurOut() << " " >> *new Html::Bold << i_ce.LocalName();
 146     CurOut() << ";";
 147 }
 148
 149
 150
 151
 152 HF_IdlAttribute::~HF_IdlAttribute()
 153 {
 154 }
 155
 156 typedef ary::idl::ifc_attribute::attr    AttributeAttr;
 157
 158 void
 159 HF_IdlAttribute::write_Declaration( const client & i_ce ) const
 160 {
 161     if (AttributeAttr::HasAnyStereotype(i_ce))
 162     {
 163         CurOut() << "[ ";
 164         if (AttributeAttr::IsReadOnly(i_ce))
 165             CurOut() << "readonly ";
 166         if (AttributeAttr::IsBound(i_ce))
 167             CurOut() << "bound ";
 168         CurOut() << "] ";
 169     }
 170
 171     HF_IdlTypeText
 172         aType( Env(), CurOut() );
 173     aType.Produce_byData( AttributeAttr::Type(i_ce) );
 174
 175     CurOut()
 176         << " "
 177         >> *new Html::Bold
 178             << i_ce.LocalName();
 179
 180     dyn_type_list pGetExceptions;
 181     dyn_type_list pSetExceptions;
 182     AttributeAttr::Get_GetExceptions(pGetExceptions, i_ce);
 183     AttributeAttr::Get_SetExceptions(pSetExceptions, i_ce);
 184
 185     bool bGetRaises = (*pGetExceptions).IsValid();
 186     bool bSetRaises = (*pSetExceptions).IsValid();
 187     bool bRaises = bGetRaises OR bSetRaises;
 188     if (bRaises)
 189     {
 190         HF_DocEntryList aSub(CurOut());
 191
 192         if (bGetRaises)
 193         {
 194             Xml::Element &
 195                 rGet = aSub.Produce_Definition();
 196             HF_IdlTypeText
 197                 aExc(Env(), rGet);
 198             type_list & itExc = *pGetExceptions;
 199
 200             rGet << "get raises (";
 201             aExc.Produce_byData(*itExc);
 202             for (++itExc; itExc.operator bool(); ++itExc)
 203             {
 204                 rGet
 205                     << ",";
 206                 aExc.Produce_byData(*itExc);
 207             }   // end for
 208             rGet << ")";
 209             if (NOT bSetRaises)
 210                 rGet << ";";
 211         }   // end if (bGetRaises)
 212
 213         if (bSetRaises)
 214         {
 215             Xml::Element &
 216                 rSet = aSub.Produce_Definition();
 217             HF_IdlTypeText
 218                 aExc(Env(), rSet);
 219             type_list & itExc = *pSetExceptions;
 220
 221             rSet << "set raises (";
 222             aExc.Produce_byData(*itExc);
 223             for (++itExc; itExc.operator bool(); ++itExc)
 224             {
 225                 rSet
 226                     << ",";
 227                 aExc.Produce_byData(*itExc);
 228             }   // end for
 229             rSet << ");";
 230         }   // end if (bSetRaises)
 231     }
 232     else
 233     {
 234         CurOut() << ";";
 235     }
 236 }
 237
 238
 239
 240
 241 HF_IdlEnumValue::~HF_IdlEnumValue()
 242 {
 243 }
 244
 245 typedef ary::idl::ifc_enumvalue::attr    EnumValueAttr;
 246
 247 void
 248 HF_IdlEnumValue::write_Declaration( const client & i_ce ) const
 249 {
 250     CurOut()
 251         >> *new Html::Bold
 252             << i_ce.LocalName();
 253
 254     const String &
 255         rValue = EnumValueAttr::Value(i_ce);
 256     if ( NOT rValue.empty() )
 257     {    CurOut() << " " // << " = "    // In the moment this is somehow in the value
 258                  << rValue;
 259         // CurOut() << ",";             // In the moment this is somehow in the value
 260     }
 261     else
 262         CurOut() << ",";
 263 }
 264
 265
 266 HF_IdlConstant::~HF_IdlConstant()
 267 {
 268 }
 269
 270 typedef ary::idl::ifc_constant::attr    ConstantAttr;
 271
 272 void
 273 HF_IdlConstant::write_Declaration( const client & i_ce ) const
 274 {
 275     CurOut() << "const ";
 276     HF_IdlTypeText
 277         aType( Env(), CurOut() );
 278     aType.Produce_byData(ConstantAttr::Type(i_ce));
 279     CurOut()
 280         << " "
 281         >> *new Html::Bold
 282             << i_ce.LocalName();
 283     const String &
 284         rValue = ConstantAttr::Value(i_ce);
 285     CurOut() << " "     // << " = "    // In the moment this is somehow in the value
 286              << rValue;
 287     // << ";";  // In the moment this is somehow in the value
 288 }
 289
 290
 291 HF_IdlStructElement::~HF_IdlStructElement()
 292 {
 293 }
 294
 295 typedef ary::idl::ifc_structelement::attr    StructElementAttr;
 296
 297 void
 298 HF_IdlStructElement::write_Declaration( const client & i_ce ) const
 299 {
 300     HF_IdlTypeText
 301         aType( Env(), CurOut() );
 302     aType.Produce_byData(StructElementAttr::Type(i_ce));
 303     CurOut()
 304         << " "
 305         >> *new Html::Bold
 306             << i_ce.LocalName();
 307     CurOut()
 308         << ";";
 309 }
 310
 311 HF_IdlCommentedRelationElement::~HF_IdlCommentedRelationElement()
 312 {
 313 }
 314
 315 void
 316 HF_IdlCommentedRelationElement::produce_Summary( Environment &   io_env,
 317                                                  Xml::Element &  io_context,
 318                                                  const comref &  i_commentedRef,
 319                                                  const client &  i_rScopeGivingCe )
 320 {
 321     csv_assert( i_commentedRef.Info() );
 322
 323     const ce_info &         rDocu = *i_commentedRef.Info();
 324
 325     bool bShort = NOT rDocu.Short().IsEmpty();
 326     bool bDescr = NOT rDocu.Description().IsEmpty();
 327
 328     if ( bShort )
 329     {
 330         HF_IdlDocuTextDisplay
 331                 aDescription(io_env, 0, i_rScopeGivingCe);
 332
 333         Xml::Element& rPara = io_context >> *new Html::Paragraph;
 334         aDescription.Out().Enter( rPara );
 335         rDocu.Short().DisplayAt( aDescription );
 336
 337         // if there's more than just the summary - i.e. a description, or usage restrictions, or tags -,
 338         // then add a link to the details section
 339         if ( bDescr OR rDocu.IsDeprecated() OR rDocu.IsOptional() OR NOT rDocu.Tags().empty() )
 340         {
 341             StreamLock aLocalLink(100);
 342             aLocalLink() << "#" << get_LocalLinkName(io_env, i_commentedRef);
 343
 344             aDescription.Out().Out() << "(";
 345             aDescription.Out().Out()
 346                 >> *new Html::Link( aLocalLink().c_str() )
 347                     << "details";
 348             aDescription.Out().Out() << ")";
 349         }
 350
 351         aDescription.Out().Leave();
 352     }
 353 }
 354
 355 void
 356 HF_IdlCommentedRelationElement::produce_LinkDoc( Environment &   io_env,
 357                                                  const client &  i_ce,
 358                                                  Xml::Element &  io_context,
 359                                                  const comref &  i_commentedRef,
 360                                                  const E_DocType i_docType )
 361 {
 362     if ( i_commentedRef.Info() != 0 )
 363     {
 364         if ( i_docType == doctype_complete )
 365         {
 366             HF_DocEntryList aDocList(io_context);
 367             HF_IdlDocu aDocuDisplay(io_env, aDocList);
 368
 369             aDocuDisplay.Produce_fromReference(*i_commentedRef.Info(), i_ce);
 370         }
 371         else
 372         {
 373             produce_Summary(io_env, io_context, i_commentedRef, i_ce);
 374         }
 375     }
 376     else
 377     {
 378         HF_DocEntryList aDocList(io_context);
 379
 380         const client *
 381             pCe = io_env.Linker().Search_CeFromType(i_commentedRef.Type());
 382         const ce_info *
 383             pShort = pCe != 0
 384                         ?   Get_IdlDocu(pCe->Docu())
 385                         :   (const ce_info *)(0);
 386         if ( pShort != 0 )
 387         {
 388             aDocList.Produce_NormalTerm("(referenced entity's summary:)");
 389             Xml::Element &
 390                 rDef = aDocList.Produce_Definition();
 391             HF_IdlDocuTextDisplay
 392                 aShortDisplay( io_env, &rDef, *pCe);
 393             pShort->Short().DisplayAt(aShortDisplay);
 394         }   // end if (pShort != 0)
 395     }   // endif ( (*i_commentedRef).Info() != 0 ) else
 396 }
 397
 398
 399 String
 400 HF_IdlCommentedRelationElement::get_LocalLinkName( Environment &  io_env,
 401                                                    const comref & i_commentedRef )
 402 {
 403     StringVector        aModules;
 404     String              sLocalName;
 405     ce_id               nCe;
 406     int                 nSequenceCount = 0;
 407
 408     const ary::idl::Type &
 409         rType = io_env.Data().Find_Type(i_commentedRef.Type());
 410     io_env.Data().Get_TypeText(aModules, sLocalName, nCe, nSequenceCount, rType);
 411
 412     // speaking strictly, this is not correct: If we have two interfaces with the same local
 413     // name, but in different modules, then the link name will be ambiguous. However, this should
 414     // be too seldom a case to really make the link names that ugly by adding the module information.
 415     return sLocalName;
 416 }
 417
 418 void
 419 HF_IdlCommentedRelationElement::write_Title( const client & /*i_ce*/ ) const
 420 {
 421
 422     Xml::Element &
 423         rAnchor = CurOut()
 424                     >> *new Html::Label(get_LocalLinkName(Env(), m_relation))
 425                         << new Html::ClassAttr(C_sMemberTitle);
 426
 427     HF_IdlTypeText
 428         aText(Env(), rAnchor);
 429     aText.Produce_byData(m_relation.Type());
 430 }
 431
 432 void
 433 HF_IdlCommentedRelationElement::write_Declaration( const client & /*i_ce*/ ) const
 434 {
 435     // nothing to do here - an entity which is a commented relation does not have a declaration
 436 }
 437
 438 void
 439 HF_IdlCommentedRelationElement::write_Description( const client & i_ce ) const
 440 {
 441     produce_LinkDoc( Env(), i_ce, CurOut(), m_relation, doctype_complete );
 442 }
 443
 444 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */