2019-10-24 06:01:50 -07:00
/*
* Copyright 2019 by its authors . See AUTHORS .
*
* Licensed under the Apache License , Version 2.0 ( the " License " ) ;
* you may not use this file except in compliance with the License .
* You may obtain a copy of the License at
*
* http : //www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing , software
* distributed under the License is distributed on an " AS IS " BASIS ,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND , either express or implied .
* See the License for the specific language governing permissions and
* limitations under the License .
*/
2017-12-06 16:03:55 -08:00
# ifndef EOLIAN_MONO_DOCUMENTATION_HPP
# define EOLIAN_MONO_DOCUMENTATION_HPP
# include "grammar/generator.hpp"
# include "grammar/klass_def.hpp"
# include "grammar/html_escaped_string.hpp"
# include "using_decl.hh"
2018-04-16 17:44:27 -07:00
# include "name_helpers.hh"
2018-12-21 05:52:11 -08:00
# include "generation_contexts.hh"
# include "blacklist.hh"
2017-12-06 16:03:55 -08:00
# include <Eina.h>
2019-07-11 01:19:52 -07:00
static const std : : string BETA_REF_SUFFIX = " (object still in beta stage) " ;
2019-07-23 11:58:42 -07:00
static const std : : string BETA_CLASS_REMARK = " This is a \\ <b \\ >BETA \\ </b \\ > class. It can be modified or removed in the future. Do not use it for product development. " ;
static const std : : string BETA_PROPERTY_REMARK = " \n \n \\ <b \\ >This is a BETA property \\ </b \\ >. It can be modified or removed in the future. Do not use it for product development. " ;
static const std : : string BETA_METHOD_REMARK = " \n \n \\ <b \\ >This is a BETA method \\ </b \\ >. It can be modified or removed in the future. Do not use it for product development. " ;
2019-07-11 01:19:52 -07:00
2017-12-06 16:03:55 -08:00
namespace eolian_mono {
struct documentation_generator
{
int scope_size = 0 ;
2019-09-23 16:50:27 -07:00
documentation_generator ( int scope_size = 0 )
2017-12-06 16:03:55 -08:00
: scope_size ( scope_size ) { }
2018-12-21 05:52:11 -08:00
// Returns the number of parameters (values + keys) that a property method requires
// Specify if you want the Setter or the Getter method.
static int property_num_parameters ( const : : Eolian_Function * function , : : Eolian_Function_Type ftype )
2017-12-06 16:03:55 -08:00
{
2018-12-21 05:52:11 -08:00
Eina_Iterator * itr = : : eolian_property_keys_get ( function , ftype ) ;
Eolian_Function_Parameter * pr ;
int n = 0 ;
EINA_ITERATOR_FOREACH ( itr , pr ) { n + + ; }
eina_iterator_free ( itr ) ;
itr = : : eolian_property_values_get ( function , ftype ) ;
EINA_ITERATOR_FOREACH ( itr , pr ) { n + + ; }
eina_iterator_free ( itr ) ;
return n ;
}
2017-12-06 16:03:55 -08:00
2019-03-21 10:38:45 -07:00
// Gets the eolian ref for the given class, prepending I for interfaces.
static std : : string object_ref_conversion ( const Eolian_Object * cls )
{
auto klass_type = : : eolian_class_type_get ( ( const Eolian_Class * ) cls ) ;
auto full_eolian_name = name_helpers : : managed_namespace ( : : eolian_object_name_get ( cls ) ) ;
if ( klass_type = = EOLIAN_CLASS_MIXIN | | klass_type = = EOLIAN_CLASS_INTERFACE )
{
size_t pos = full_eolian_name . rfind ( " . " ) ;
if ( pos = = std : : string : : npos )
pos = 0 ;
else
pos + + ;
full_eolian_name . insert ( pos , " I " ) ;
}
return full_eolian_name ;
}
2018-12-21 05:52:11 -08:00
// Turns a function name from EO convention to EFL# convention.
// The name_tail parameter is the last 4 chars of the original string, which
// could be ".set" or ".get" and in this case they are ignored by Eolian.
// We want them to know what the documentation intended to reference.
static std : : string function_conversion ( const : : Eolian_Object * klass , const : : Eolian_Function * function , std : : string name_tail )
{
: : Eolian_Function_Type ftype = : : eolian_function_type_get ( function ) ;
const char * eo_name = : : eolian_function_name_get ( function ) ;
2019-03-21 10:38:45 -07:00
std : : string name = object_ref_conversion ( klass ) ;
2019-04-15 11:58:30 -07:00
// Klass is needed to check the property naming rulles
attributes : : klass_def klass_d ( ( const : : Eolian_Class * ) klass , eolian_object_unit_get ( klass ) ) ;
csharp: Skip non-public members from interfaces
Summary:
Eolian allows non-public members in interfaces and mixins (usually
@protected). As both kinds are converted to C# interfaces, this
causes problem as non-public members are forbidden in C# interfaces.
This commit changes eolian_mono by removing those members from the C#
interfaces. If a generated class implements the interface, the method is
generated as if it were a protected member of the class directly.
For mixed properties like `Efl.Io.Reader.CanRead { get; set @protected; }`,
the interface has only the public getter and the the implementing class has both
the public getter and the protected setter.
With this, C# devs won't be able to directly implement protected Eo
methods from interfaces. (But this really does not make sense from the
C# point of view).
ref T7494
Reviewers: segfaultxavi, felipealmeida, YOhoho
Reviewed By: YOhoho
Subscribers: cedric, brunobelo, Jaehyun_Cho, #reviewers, woohyun, #committers
Tags: #efl
Maniphest Tasks: T7494
Differential Revision: https://phab.enlightenment.org/D9800
2019-09-10 15:30:46 -07:00
// Comment the block below to enable @see reference conversion for non-public interface members.
// As they are not generated, this causes a doc warning that fails the build, but can be useful to track
// public methods referencing protected stuff.
if ( ftype ! = EOLIAN_PROPERTY )
{
bool is_func_public = : : eolian_function_scope_get ( function , ftype ) = = EOLIAN_SCOPE_PUBLIC ;
if ( helpers : : is_managed_interface ( klass_d ) & & ! is_func_public )
return " " ;
}
else
{
bool is_get_public = : : eolian_function_scope_get ( function , EOLIAN_PROP_GET ) = = EOLIAN_SCOPE_PUBLIC ;
bool is_set_public = : : eolian_function_scope_get ( function , EOLIAN_PROP_SET ) = = EOLIAN_SCOPE_PUBLIC ;
if ( helpers : : is_managed_interface ( klass_d ) & & ! ( is_get_public | | is_set_public ) )
return " " ;
}
2018-12-21 05:52:11 -08:00
switch ( ftype )
{
case : : EOLIAN_METHOD :
if ( blacklist : : is_function_blacklisted (
2019-03-08 06:58:52 -08:00
: : eolian_function_full_c_name_get ( function , ftype ) ) ) return " " ;
2018-12-21 05:52:11 -08:00
name + = " . " ;
2019-04-23 03:19:09 -07:00
name + = name_helpers : : managed_method_name ( { function , ftype , NULL , eolian_object_unit_get ( EOLIAN_OBJECT ( function ) ) } ) ;
2018-12-21 05:52:11 -08:00
break ;
case : : EOLIAN_PROP_SET :
name + = " .Set " ;
2019-04-15 11:58:30 -07:00
name + = name_helpers : : property_managed_name ( klass_d , eo_name ) ;
2018-12-21 05:52:11 -08:00
break ;
case : : EOLIAN_PROP_GET :
name + = " .Get " ;
2019-04-15 11:58:30 -07:00
name + = name_helpers : : property_managed_name ( klass_d , eo_name ) ;
2018-12-21 05:52:11 -08:00
break ;
case : : EOLIAN_PROPERTY :
{
int getter_params = property_num_parameters ( function , : : EOLIAN_PROP_GET ) ;
int setter_params = property_num_parameters ( function , : : EOLIAN_PROP_SET ) ;
2019-04-15 11:58:30 -07:00
std : : string short_name = name_helpers : : property_managed_name ( klass_d , eo_name ) ;
2018-12-21 05:52:11 -08:00
bool blacklisted = blacklist : : is_property_blacklisted ( name + " . " + short_name ) ;
// EO properties with keys, with more than one value, or blacklisted, are not
// converted into C# properties.
// In these cases we refer to the getter method instead of the property.
if ( ( getter_params > 1 ) | | ( setter_params > 1 ) | | ( blacklisted ) ) name + = " .Get " + short_name ;
else if ( name_tail = = " .get " ) name + = " .Get " + short_name ;
else if ( name_tail = = " .set " ) name + = " .Set " + short_name ;
else name + = " . " + short_name ;
}
break ;
default :
break ;
}
return name ;
2017-12-06 16:03:55 -08:00
}
2019-02-01 11:03:02 -08:00
static std : : string function_conversion ( attributes : : function_def const & func )
{
csharp: Skip non-public members from interfaces
Summary:
Eolian allows non-public members in interfaces and mixins (usually
@protected). As both kinds are converted to C# interfaces, this
causes problem as non-public members are forbidden in C# interfaces.
This commit changes eolian_mono by removing those members from the C#
interfaces. If a generated class implements the interface, the method is
generated as if it were a protected member of the class directly.
For mixed properties like `Efl.Io.Reader.CanRead { get; set @protected; }`,
the interface has only the public getter and the the implementing class has both
the public getter and the protected setter.
With this, C# devs won't be able to directly implement protected Eo
methods from interfaces. (But this really does not make sense from the
C# point of view).
ref T7494
Reviewers: segfaultxavi, felipealmeida, YOhoho
Reviewed By: YOhoho
Subscribers: cedric, brunobelo, Jaehyun_Cho, #reviewers, woohyun, #committers
Tags: #efl
Maniphest Tasks: T7494
Differential Revision: https://phab.enlightenment.org/D9800
2019-09-10 15:30:46 -07:00
// This function is called only from the constructor reference conversion, so it does not
// need to check whether this function non-public in a interface returning an empty reference (yet).
2019-04-11 01:36:53 -07:00
std : : string name = name_helpers : : klass_full_concrete_or_interface_name ( func . klass ) ;
2019-02-01 11:03:02 -08:00
switch ( func . type )
{
// managed_method_name takes care of reordering the function name so the get/set goes first
// for properties
case attributes : : function_type : : method :
case attributes : : function_type : : prop_set :
case attributes : : function_type : : prop_get :
if ( blacklist : : is_function_blacklisted ( func . c_name ) ) return " " ;
2019-04-11 01:36:53 -07:00
if ( ! name . empty ( ) ) name + = " . " ;
2019-04-23 03:19:09 -07:00
name + = name_helpers : : managed_method_name ( func ) ;
2019-02-01 11:03:02 -08:00
break ;
default :
// No need to deal with property as function_defs are converted to get/set when building a given klass_def.
break ;
}
return name ;
}
2018-12-21 05:52:11 -08:00
// Turns an Eolian reference like @Efl.Input.Pointer.tool into a <see> tag
2019-07-11 01:19:52 -07:00
static std : : string ref_conversion ( const : : Eolian_Doc_Token * token , const Eolian_State * state , std : : string name_tail ,
bool want_beta )
2018-12-21 05:52:11 -08:00
{
const Eolian_Object * data , * data2 ;
: : Eolian_Object_Type type =
: : eolian_doc_token_ref_resolve ( token , state , & data , & data2 ) ;
std : : string ref ;
2019-07-11 01:19:52 -07:00
bool is_beta = false ;
2018-12-21 05:52:11 -08:00
switch ( type )
{
case : : EOLIAN_OBJECT_STRUCT_FIELD :
ref = name_helpers : : managed_namespace ( : : eolian_object_name_get ( data ) ) ;
ref + = " . " ;
ref + = : : eolian_object_name_get ( data2 ) ;
2019-07-11 01:19:52 -07:00
is_beta = eolian_object_is_beta ( data ) | | eolian_object_is_beta ( data2 ) ;
2018-12-21 05:52:11 -08:00
if ( blacklist : : is_struct_blacklisted ( ref ) ) return " " ;
break ;
case : : EOLIAN_OBJECT_EVENT :
2019-03-21 10:38:45 -07:00
ref = object_ref_conversion ( data ) ;
2018-12-21 05:52:11 -08:00
ref + = " . " ;
ref + = name_helpers : : managed_event_name ( : : eolian_object_name_get ( data2 ) ) ;
2019-07-11 01:19:52 -07:00
is_beta = eolian_object_is_beta ( data ) | | eolian_object_is_beta ( data2 ) ;
2018-12-21 05:52:11 -08:00
break ;
case : : EOLIAN_OBJECT_ENUM_FIELD :
ref = name_helpers : : managed_namespace ( : : eolian_object_name_get ( data ) ) ;
ref + = " . " ;
ref + = name_helpers : : enum_field_managed_name ( : : eolian_object_name_get ( data2 ) ) ;
2019-07-11 01:19:52 -07:00
is_beta = eolian_object_is_beta ( data ) | | eolian_object_is_beta ( data2 ) ;
2018-12-21 05:52:11 -08:00
break ;
case : : EOLIAN_OBJECT_FUNCTION :
ref + = function_conversion ( data , ( const : : Eolian_Function * ) data2 , name_tail ) ;
2019-07-11 01:19:52 -07:00
is_beta = eolian_object_is_beta ( data ) | | eolian_object_is_beta ( data2 ) ;
2018-12-21 05:52:11 -08:00
break ;
2019-09-24 08:06:24 -07:00
case : : EOLIAN_OBJECT_CONSTANT :
2019-09-24 12:50:49 -07:00
{
auto names = utils : : split ( name_helpers : : managed_namespace ( : : eolian_object_name_get ( data ) ) , ' . ' ) ;
names . pop_back ( ) ; // Remove var name
ref = name_helpers : : join_namespaces ( names , ' . ' ) ;
ref + = " Constants. " ;
ref + = name_helpers : : managed_name ( : : eolian_object_short_name_get ( data ) ) ;
}
2019-02-28 01:38:47 -08:00
break ;
2018-12-21 05:52:11 -08:00
case : : EOLIAN_OBJECT_UNKNOWN :
// If the reference cannot be resolved, just return an empty string and
// it won't be converted into a <see> tag.
break ;
2019-03-21 10:38:45 -07:00
case : : EOLIAN_OBJECT_CLASS :
ref = object_ref_conversion ( data ) ;
2019-07-11 01:19:52 -07:00
is_beta = eolian_object_is_beta ( data ) ;
2019-03-21 10:38:45 -07:00
break ;
2018-12-21 05:52:11 -08:00
default :
ref = name_helpers : : managed_namespace ( : : eolian_object_name_get ( data ) ) ;
2019-07-11 01:19:52 -07:00
is_beta = eolian_object_is_beta ( data ) ;
2018-12-21 05:52:11 -08:00
break ;
}
2019-07-11 01:19:52 -07:00
if ( ! ref . empty ( ) & & ! want_beta & & is_beta )
ref + = BETA_REF_SUFFIX ;
2018-12-21 05:52:11 -08:00
return ref ;
}
// Turns EO documentation syntax into C# triple-slash XML comment syntax
2019-07-11 01:19:52 -07:00
static std : : string syntax_conversion ( std : : string text , const Eolian_State * state , bool want_beta )
2018-12-21 05:52:11 -08:00
{
std : : string new_text , ref ;
: : Eolian_Doc_Token token ;
const char * text_ptr = text . c_str ( ) ;
: : eolian_doc_token_init ( & token ) ;
2018-12-21 08:52:34 -08:00
: : Eolian_Doc_Token_Type previous_token_type = : : EOLIAN_DOC_TOKEN_UNKNOWN ;
2018-12-21 05:52:11 -08:00
while ( ( text_ptr = : : eolian_documentation_tokenize ( text_ptr , & token ) ) ! = NULL )
{
std : : string token_text , name_tail ;
char * token_text_cstr = : : eolian_doc_token_text_get ( & token ) ;
if ( token_text_cstr )
{
token_text = token_text_cstr ;
free ( token_text_cstr ) ;
if ( token_text . length ( ) > 4 )
2018-12-21 08:52:34 -08:00
name_tail = token_text . substr ( token_text . length ( ) - 4 , 4 ) ;
2018-12-21 05:52:11 -08:00
}
2018-12-21 08:52:34 -08:00
: : Eolian_Doc_Token_Type token_type = : : eolian_doc_token_type_get ( & token ) ;
switch ( token_type )
2018-12-21 05:52:11 -08:00
{
case : : EOLIAN_DOC_TOKEN_TEXT :
2018-12-21 08:52:34 -08:00
// If previous token was a reference and this text token starts with
// parentheses, remove them, since the reference will be rendered
// with the parentheses already.
if ( ( previous_token_type = = : : EOLIAN_DOC_TOKEN_REF ) & &
( token_text . substr ( 0 , 2 ) = = " () " ) )
token_text = token_text . substr ( 2 , token_text . length ( ) - 2 ) ;
2018-12-21 05:52:11 -08:00
new_text + = token_text ;
break ;
case : : EOLIAN_DOC_TOKEN_REF :
2019-07-11 01:19:52 -07:00
ref = ref_conversion ( & token , state , name_tail , want_beta ) ;
2018-12-21 05:52:11 -08:00
if ( ref ! = " " )
2019-07-11 01:19:52 -07:00
{
if ( utils : : ends_with ( ref , BETA_REF_SUFFIX ) )
new_text + = " <span class= \" text-muted \" > " + ref + " </span> " ;
else
new_text + = " <see cref= \" " + ref + " \" /> " ;
}
2018-12-21 05:52:11 -08:00
else
// Unresolved references are passed through.
// They will appear in the docs as plain text, without link,
// but at least they won't be removed by DocFX.
new_text + = token_text ;
break ;
case : : EOLIAN_DOC_TOKEN_MARK_NOTE :
new_text + = " NOTE: " + token_text ;
break ;
case : : EOLIAN_DOC_TOKEN_MARK_WARNING :
new_text + = " WARNING: " + token_text ;
break ;
case : : EOLIAN_DOC_TOKEN_MARK_REMARK :
new_text + = " REMARK: " + token_text ;
break ;
case : : EOLIAN_DOC_TOKEN_MARK_TODO :
new_text + = " TODO: " + token_text ;
break ;
case : : EOLIAN_DOC_TOKEN_MARKUP_MONOSPACE :
new_text + = " <c> " + token_text + " </c> " ;
break ;
default :
break ;
}
2018-12-21 08:52:34 -08:00
previous_token_type = token_type ;
2018-12-21 05:52:11 -08:00
}
return new_text ;
}
/// Tag generator helpers
2017-12-06 16:03:55 -08:00
template < typename OutputIterator , typename Context >
2019-04-11 01:37:33 -07:00
bool generate_opening_tag ( OutputIterator sink , std : : string const & tag , Context const & context , std : : string tag_params = " " ) const
{
return as_generator ( " < " < < tag < < tag_params < < " > " ) . generate ( sink , attributes : : unused , context ) ;
}
template < typename OutputIterator , typename Context >
bool generate_closing_tag ( OutputIterator sink , std : : string const & tag , Context const & context ) const
{
return as_generator ( " </ " < < tag < < " > " ) . generate ( sink , attributes : : unused , context ) ;
}
template < typename OutputIterator , typename Context >
bool generate_escaped_content ( OutputIterator sink , std : : string const & text , Context const & context ) const
2017-12-06 16:03:55 -08:00
{
2018-12-21 05:52:11 -08:00
std : : string new_text ;
if ( ! as_generator ( html_escaped_string ) . generate ( std : : back_inserter ( new_text ) , text , context ) )
return false ;
2019-07-11 01:19:52 -07:00
auto options = context_find_tag < options_context > ( context ) ;
new_text = syntax_conversion ( new_text , context_find_tag < eolian_state_context > ( context ) . state , options . want_beta ) ;
2018-12-21 05:52:11 -08:00
std : : string tabs ;
as_generator ( scope_tab ( scope_size ) < < " /// " ) . generate ( std : : back_inserter ( tabs ) , attributes : : unused , context ) ;
std : : istringstream ss ( new_text ) ;
std : : string para ;
2019-04-11 01:37:33 -07:00
std : : string final_text ;
2018-12-21 05:52:11 -08:00
bool first = true ;
while ( std : : getline ( ss , para ) ) {
if ( first ) final_text + = para ;
else final_text + = " \n " + tabs + para ;
first = false ;
}
2019-04-11 01:37:33 -07:00
return as_generator ( final_text ) . generate ( sink , attributes : : unused , context ) ;
}
template < typename OutputIterator , typename Context >
bool generate_tag ( OutputIterator sink , std : : string const & tag , std : : string const & text , Context const & context , std : : string tag_params = " " ) const
{
2019-04-22 13:53:30 -07:00
if ( text = = " " )
return true ;
2019-04-11 01:37:33 -07:00
if ( ! as_generator ( scope_tab ( scope_size ) < < " /// " ) . generate ( sink , attributes : : unused , context ) ) return false ;
if ( ! generate_opening_tag ( sink , tag , context , tag_params ) ) return false ;
if ( ! generate_escaped_content ( sink , text , context ) ) return false ;
if ( ! generate_closing_tag ( sink , tag , context ) ) return false ;
return as_generator ( " \n " ) . generate ( sink , attributes : : unused , context ) ;
2017-12-06 16:03:55 -08:00
}
template < typename OutputIterator , typename Context >
2018-12-21 05:52:11 -08:00
bool generate_tag_summary ( OutputIterator sink , std : : string const & text , Context const & context ) const
2017-12-06 16:03:55 -08:00
{
2018-12-21 05:52:11 -08:00
return generate_tag ( sink , " summary " , text , context ) ;
2017-12-06 16:03:55 -08:00
}
template < typename OutputIterator , typename Context >
bool generate_tag_param ( OutputIterator sink , std : : string const & name , std : : string const & text , Context const & context ) const
{
2018-12-21 05:52:11 -08:00
return generate_tag ( sink , " param " , text , context , " name= \" " + name + " \" " ) ;
2017-12-06 16:03:55 -08:00
}
template < typename OutputIterator , typename Context >
bool generate_tag_return ( OutputIterator sink , std : : string const & text , Context const & context ) const
{
2018-12-21 05:52:11 -08:00
return generate_tag ( sink , " returns " , text , context ) ;
2017-12-06 16:03:55 -08:00
}
2019-02-19 04:29:09 -08:00
template < typename OutputIterator , typename Context >
bool generate_tag_value ( OutputIterator sink , std : : string const & text , Context const & context ) const
{
return generate_tag ( sink , " value " , text , context ) ;
}
2019-04-11 01:37:33 -07:00
template < typename OutputIterator , typename Context >
2019-04-11 03:40:21 -07:00
bool generate_tag_example ( OutputIterator sink , std : : string const & full_object_name , Context const & context ) const
2019-04-11 01:37:33 -07:00
{
mono-docs: Allow embedding external examples
Summary:
New option added to eolian_gen: -e <dir>
This specifies a directory to search for examples. If a file is found with the
same name as an EFL C# class (e.g. Efl.Ui.Button.cs) or as an EFL C# method or
property (e.g. Efl.IText.Text.cs, Efl.IText.SetText.cs) its full
contents will be embedded in the documentation for that class or method within
<example> and <code> tags. This is, in turn, is parsed by DocFX and shown
in Example boxes in the generated pages.
If an example file is not found, no examples are embedded for that object.
If -e is not used, no examples are embedded for any object.
New option added to meson: mono-examples-dir to point to the examples directory.
This directory is then passed to eolian_mono through -e.
Do not use it (or define it to nothing) to disable example embedding.
No performance drop has been observed because of these extra tests.
Right now examples can only be given for base classes, not for derived ones
(i.e. Efl.IText.Text but not Efl.Ui.Button.Text). This will be addressed in a
later commit.
Feature
Depends on D8587
Test Plan:
Create an examples folder and put some files in it:
```
mkdir /tmp/examples
echo 'var button = new Efl.Ui.Button();' > /tmp/examples/Efl.Ui.Button.cs
echo 'button.AutoRepeatEnabled = true;' > /tmp/examples/Efl.Ui.IAutorepeat.AutorepeatEnabled.cs
echo 'button.SetAutoRepeatEnabled(true);' > /tmp/examples/Efl.Ui.IAutorepeat.SetAutorepeatEnabled.cs
```
Configure meson to embed examples and build:
```
meson configure -Dmono-examples-dir=/tmp/examples
ninja
```
Examine the generated efl_ui_button.eo.cs file to see embedded <example> tags,
or run DocFX and bask in the glory of documentation pages with examples:
```
cd doc/docfx
./gendoc.sh
```
Reviewers: lauromoura, felipealmeida, vitor.sousa, zmike, bu5hm4n
Reviewed By: vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8592
2019-04-11 01:38:40 -07:00
auto options = efl : : eolian : : grammar : : context_find_tag < options_context > ( context ) ;
// Example embedding not requested
if ( options . examples_dir . empty ( ) ) return true ;
2019-09-17 03:02:19 -07:00
bool is_plain_code = false ;
std : : string file_name = options . examples_dir + full_object_name + " .xml " ;
mono-docs: Allow embedding external examples
Summary:
New option added to eolian_gen: -e <dir>
This specifies a directory to search for examples. If a file is found with the
same name as an EFL C# class (e.g. Efl.Ui.Button.cs) or as an EFL C# method or
property (e.g. Efl.IText.Text.cs, Efl.IText.SetText.cs) its full
contents will be embedded in the documentation for that class or method within
<example> and <code> tags. This is, in turn, is parsed by DocFX and shown
in Example boxes in the generated pages.
If an example file is not found, no examples are embedded for that object.
If -e is not used, no examples are embedded for any object.
New option added to meson: mono-examples-dir to point to the examples directory.
This directory is then passed to eolian_mono through -e.
Do not use it (or define it to nothing) to disable example embedding.
No performance drop has been observed because of these extra tests.
Right now examples can only be given for base classes, not for derived ones
(i.e. Efl.IText.Text but not Efl.Ui.Button.Text). This will be addressed in a
later commit.
Feature
Depends on D8587
Test Plan:
Create an examples folder and put some files in it:
```
mkdir /tmp/examples
echo 'var button = new Efl.Ui.Button();' > /tmp/examples/Efl.Ui.Button.cs
echo 'button.AutoRepeatEnabled = true;' > /tmp/examples/Efl.Ui.IAutorepeat.AutorepeatEnabled.cs
echo 'button.SetAutoRepeatEnabled(true);' > /tmp/examples/Efl.Ui.IAutorepeat.SetAutorepeatEnabled.cs
```
Configure meson to embed examples and build:
```
meson configure -Dmono-examples-dir=/tmp/examples
ninja
```
Examine the generated efl_ui_button.eo.cs file to see embedded <example> tags,
or run DocFX and bask in the glory of documentation pages with examples:
```
cd doc/docfx
./gendoc.sh
```
Reviewers: lauromoura, felipealmeida, vitor.sousa, zmike, bu5hm4n
Reviewed By: vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8592
2019-04-11 01:38:40 -07:00
std : : ifstream exfile ( file_name ) ;
2019-09-17 03:02:19 -07:00
if ( ! exfile . good ( ) )
{
// There is no example XML file for this class, try a CS file
file_name = options . examples_dir + full_object_name + " .cs " ;
exfile . open ( file_name ) ;
// There are no example files for this class or method, just return
if ( ! exfile . good ( ) ) return true ;
is_plain_code = true ;
}
mono-docs: Allow embedding external examples
Summary:
New option added to eolian_gen: -e <dir>
This specifies a directory to search for examples. If a file is found with the
same name as an EFL C# class (e.g. Efl.Ui.Button.cs) or as an EFL C# method or
property (e.g. Efl.IText.Text.cs, Efl.IText.SetText.cs) its full
contents will be embedded in the documentation for that class or method within
<example> and <code> tags. This is, in turn, is parsed by DocFX and shown
in Example boxes in the generated pages.
If an example file is not found, no examples are embedded for that object.
If -e is not used, no examples are embedded for any object.
New option added to meson: mono-examples-dir to point to the examples directory.
This directory is then passed to eolian_mono through -e.
Do not use it (or define it to nothing) to disable example embedding.
No performance drop has been observed because of these extra tests.
Right now examples can only be given for base classes, not for derived ones
(i.e. Efl.IText.Text but not Efl.Ui.Button.Text). This will be addressed in a
later commit.
Feature
Depends on D8587
Test Plan:
Create an examples folder and put some files in it:
```
mkdir /tmp/examples
echo 'var button = new Efl.Ui.Button();' > /tmp/examples/Efl.Ui.Button.cs
echo 'button.AutoRepeatEnabled = true;' > /tmp/examples/Efl.Ui.IAutorepeat.AutorepeatEnabled.cs
echo 'button.SetAutoRepeatEnabled(true);' > /tmp/examples/Efl.Ui.IAutorepeat.SetAutorepeatEnabled.cs
```
Configure meson to embed examples and build:
```
meson configure -Dmono-examples-dir=/tmp/examples
ninja
```
Examine the generated efl_ui_button.eo.cs file to see embedded <example> tags,
or run DocFX and bask in the glory of documentation pages with examples:
```
cd doc/docfx
./gendoc.sh
```
Reviewers: lauromoura, felipealmeida, vitor.sousa, zmike, bu5hm4n
Reviewed By: vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8592
2019-04-11 01:38:40 -07:00
std : : stringstream example_buff ;
2019-04-11 04:18:33 -07:00
// Start with a newline so the first line renders with same indentation as the rest
example_buff < < std : : endl < < exfile . rdbuf ( ) ;
mono-docs: Allow embedding external examples
Summary:
New option added to eolian_gen: -e <dir>
This specifies a directory to search for examples. If a file is found with the
same name as an EFL C# class (e.g. Efl.Ui.Button.cs) or as an EFL C# method or
property (e.g. Efl.IText.Text.cs, Efl.IText.SetText.cs) its full
contents will be embedded in the documentation for that class or method within
<example> and <code> tags. This is, in turn, is parsed by DocFX and shown
in Example boxes in the generated pages.
If an example file is not found, no examples are embedded for that object.
If -e is not used, no examples are embedded for any object.
New option added to meson: mono-examples-dir to point to the examples directory.
This directory is then passed to eolian_mono through -e.
Do not use it (or define it to nothing) to disable example embedding.
No performance drop has been observed because of these extra tests.
Right now examples can only be given for base classes, not for derived ones
(i.e. Efl.IText.Text but not Efl.Ui.Button.Text). This will be addressed in a
later commit.
Feature
Depends on D8587
Test Plan:
Create an examples folder and put some files in it:
```
mkdir /tmp/examples
echo 'var button = new Efl.Ui.Button();' > /tmp/examples/Efl.Ui.Button.cs
echo 'button.AutoRepeatEnabled = true;' > /tmp/examples/Efl.Ui.IAutorepeat.AutorepeatEnabled.cs
echo 'button.SetAutoRepeatEnabled(true);' > /tmp/examples/Efl.Ui.IAutorepeat.SetAutorepeatEnabled.cs
```
Configure meson to embed examples and build:
```
meson configure -Dmono-examples-dir=/tmp/examples
ninja
```
Examine the generated efl_ui_button.eo.cs file to see embedded <example> tags,
or run DocFX and bask in the glory of documentation pages with examples:
```
cd doc/docfx
./gendoc.sh
```
Reviewers: lauromoura, felipealmeida, vitor.sousa, zmike, bu5hm4n
Reviewed By: vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8592
2019-04-11 01:38:40 -07:00
2019-04-11 01:37:33 -07:00
if ( ! as_generator ( scope_tab ( scope_size ) < < " /// " ) . generate ( sink , attributes : : unused , context ) ) return false ;
2019-09-17 03:02:19 -07:00
if ( is_plain_code )
{
if ( ! generate_opening_tag ( sink , " example " , context ) ) return false ;
if ( ! generate_opening_tag ( sink , " code " , context ) ) return false ;
}
mono-docs: Allow embedding external examples
Summary:
New option added to eolian_gen: -e <dir>
This specifies a directory to search for examples. If a file is found with the
same name as an EFL C# class (e.g. Efl.Ui.Button.cs) or as an EFL C# method or
property (e.g. Efl.IText.Text.cs, Efl.IText.SetText.cs) its full
contents will be embedded in the documentation for that class or method within
<example> and <code> tags. This is, in turn, is parsed by DocFX and shown
in Example boxes in the generated pages.
If an example file is not found, no examples are embedded for that object.
If -e is not used, no examples are embedded for any object.
New option added to meson: mono-examples-dir to point to the examples directory.
This directory is then passed to eolian_mono through -e.
Do not use it (or define it to nothing) to disable example embedding.
No performance drop has been observed because of these extra tests.
Right now examples can only be given for base classes, not for derived ones
(i.e. Efl.IText.Text but not Efl.Ui.Button.Text). This will be addressed in a
later commit.
Feature
Depends on D8587
Test Plan:
Create an examples folder and put some files in it:
```
mkdir /tmp/examples
echo 'var button = new Efl.Ui.Button();' > /tmp/examples/Efl.Ui.Button.cs
echo 'button.AutoRepeatEnabled = true;' > /tmp/examples/Efl.Ui.IAutorepeat.AutorepeatEnabled.cs
echo 'button.SetAutoRepeatEnabled(true);' > /tmp/examples/Efl.Ui.IAutorepeat.SetAutorepeatEnabled.cs
```
Configure meson to embed examples and build:
```
meson configure -Dmono-examples-dir=/tmp/examples
ninja
```
Examine the generated efl_ui_button.eo.cs file to see embedded <example> tags,
or run DocFX and bask in the glory of documentation pages with examples:
```
cd doc/docfx
./gendoc.sh
```
Reviewers: lauromoura, felipealmeida, vitor.sousa, zmike, bu5hm4n
Reviewed By: vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8592
2019-04-11 01:38:40 -07:00
if ( ! generate_escaped_content ( sink , example_buff . str ( ) , context ) ) return false ;
2019-09-17 03:02:19 -07:00
if ( is_plain_code )
{
if ( ! generate_closing_tag ( sink , " code " , context ) ) return false ;
if ( ! generate_closing_tag ( sink , " example " , context ) ) return false ;
}
2019-04-11 01:37:33 -07:00
return as_generator ( " \n " ) . generate ( sink , attributes : : unused , context ) ;
}
2019-04-11 03:40:21 -07:00
template < typename OutputIterator , typename Context >
bool generate_all_tag_examples ( OutputIterator sink , std : : string const & full_class_name , std : : string const & object_name , Context const & context ) const
{
// Take example from derived class
auto derived_klass = efl : : eolian : : grammar : : context_find_tag < class_context > ( context ) ;
std : : string derived_full_name =
derived_klass . name . empty ( ) ? object_name : derived_klass . name + " . " + object_name ;
std : : string base_full_name =
full_class_name . empty ( ) ? object_name : full_class_name + " . " + object_name ;
if ( ! derived_klass . name . empty ( ) )
{
if ( ! generate_tag_example ( sink , derived_full_name , context ) ) return false ;
}
if ( derived_full_name . compare ( base_full_name ) = = 0 ) return true ;
// Take example from base class
return generate_tag_example ( sink , base_full_name , context ) ;
}
2017-12-06 16:03:55 -08:00
// Actual exported generators
template < typename OutputIterator , typename Attribute , typename Context >
bool generate ( OutputIterator sink , Attribute const & attr , Context const & context ) const
{
return generate ( sink , attr . documentation , context ) ;
}
mono-docs: Allow embedding external examples
Summary:
New option added to eolian_gen: -e <dir>
This specifies a directory to search for examples. If a file is found with the
same name as an EFL C# class (e.g. Efl.Ui.Button.cs) or as an EFL C# method or
property (e.g. Efl.IText.Text.cs, Efl.IText.SetText.cs) its full
contents will be embedded in the documentation for that class or method within
<example> and <code> tags. This is, in turn, is parsed by DocFX and shown
in Example boxes in the generated pages.
If an example file is not found, no examples are embedded for that object.
If -e is not used, no examples are embedded for any object.
New option added to meson: mono-examples-dir to point to the examples directory.
This directory is then passed to eolian_mono through -e.
Do not use it (or define it to nothing) to disable example embedding.
No performance drop has been observed because of these extra tests.
Right now examples can only be given for base classes, not for derived ones
(i.e. Efl.IText.Text but not Efl.Ui.Button.Text). This will be addressed in a
later commit.
Feature
Depends on D8587
Test Plan:
Create an examples folder and put some files in it:
```
mkdir /tmp/examples
echo 'var button = new Efl.Ui.Button();' > /tmp/examples/Efl.Ui.Button.cs
echo 'button.AutoRepeatEnabled = true;' > /tmp/examples/Efl.Ui.IAutorepeat.AutorepeatEnabled.cs
echo 'button.SetAutoRepeatEnabled(true);' > /tmp/examples/Efl.Ui.IAutorepeat.SetAutorepeatEnabled.cs
```
Configure meson to embed examples and build:
```
meson configure -Dmono-examples-dir=/tmp/examples
ninja
```
Examine the generated efl_ui_button.eo.cs file to see embedded <example> tags,
or run DocFX and bask in the glory of documentation pages with examples:
```
cd doc/docfx
./gendoc.sh
```
Reviewers: lauromoura, felipealmeida, vitor.sousa, zmike, bu5hm4n
Reviewed By: vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8592
2019-04-11 01:38:40 -07:00
template < typename OutputIterator , typename Context >
bool generate ( OutputIterator sink , attributes : : klass_def const & klass , Context const & context ) const
{
if ( ! generate ( sink , klass . documentation , context ) ) return false ;
2019-07-23 07:38:04 -07:00
if ( klass . is_beta )
{
2019-07-23 11:58:42 -07:00
if ( ! generate_tag ( sink , " remarks " , BETA_CLASS_REMARK , context ) ) return false ;
2019-07-23 07:38:04 -07:00
}
mono-docs: Allow embedding external examples
Summary:
New option added to eolian_gen: -e <dir>
This specifies a directory to search for examples. If a file is found with the
same name as an EFL C# class (e.g. Efl.Ui.Button.cs) or as an EFL C# method or
property (e.g. Efl.IText.Text.cs, Efl.IText.SetText.cs) its full
contents will be embedded in the documentation for that class or method within
<example> and <code> tags. This is, in turn, is parsed by DocFX and shown
in Example boxes in the generated pages.
If an example file is not found, no examples are embedded for that object.
If -e is not used, no examples are embedded for any object.
New option added to meson: mono-examples-dir to point to the examples directory.
This directory is then passed to eolian_mono through -e.
Do not use it (or define it to nothing) to disable example embedding.
No performance drop has been observed because of these extra tests.
Right now examples can only be given for base classes, not for derived ones
(i.e. Efl.IText.Text but not Efl.Ui.Button.Text). This will be addressed in a
later commit.
Feature
Depends on D8587
Test Plan:
Create an examples folder and put some files in it:
```
mkdir /tmp/examples
echo 'var button = new Efl.Ui.Button();' > /tmp/examples/Efl.Ui.Button.cs
echo 'button.AutoRepeatEnabled = true;' > /tmp/examples/Efl.Ui.IAutorepeat.AutorepeatEnabled.cs
echo 'button.SetAutoRepeatEnabled(true);' > /tmp/examples/Efl.Ui.IAutorepeat.SetAutorepeatEnabled.cs
```
Configure meson to embed examples and build:
```
meson configure -Dmono-examples-dir=/tmp/examples
ninja
```
Examine the generated efl_ui_button.eo.cs file to see embedded <example> tags,
or run DocFX and bask in the glory of documentation pages with examples:
```
cd doc/docfx
./gendoc.sh
```
Reviewers: lauromoura, felipealmeida, vitor.sousa, zmike, bu5hm4n
Reviewed By: vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8592
2019-04-11 01:38:40 -07:00
std : : string klass_name = name_helpers : : klass_full_concrete_or_interface_name ( klass ) ;
return generate_tag_example ( sink , klass_name , context ) ;
}
2019-02-19 04:29:09 -08:00
template < typename OutputIterator , typename Context >
bool generate ( OutputIterator sink , attributes : : property_def const & prop , Context const & context ) const
{
mono-docs: Merge Property and getter/setter docs
Summary:
Property docs, when present, should always be included in Property and Accessor
(setter and getter) docs.
Accessor docs, when present, should be included in their accessor method, and
also in the property method, as a side note.
This patch does just that.
Depends on D10285
Ref T8309
Test Plan: Generate docs and take a look at `Efl.Ui.Calendar`, for example, which has a bit of everything.
Reviewers: lauromoura
Reviewed By: lauromoura
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8309
Differential Revision: https://phab.enlightenment.org/D10298
2019-10-09 07:18:14 -07:00
// Generate docs by merging Property, Accessor, Since and Beta pieces.
std : : string text = prop . documentation . full_text ;
if ( ! prop . documentation . since . empty ( ) )
text + = " \\ <br/ \\ > \n Since EFL " + prop . documentation . since + " . " ;
if ( prop . setter . is_engaged ( ) & & ! prop . setter - > documentation . full_text . empty ( ) )
text + = " \\ <br/ \\ > \n \\ <b \\ >Note on writing: \\ </b \\ > " + prop . setter - > documentation . full_text ;
if ( prop . getter . is_engaged ( ) & & ! prop . getter - > documentation . full_text . empty ( ) )
text + = " \\ <br/ \\ > \n \\ <b \\ >Note on reading: \\ </b \\ > " + prop . getter - > documentation . full_text ;
2019-07-23 11:58:42 -07:00
if ( ! prop . klass . is_beta )
{
if ( ( prop . setter . is_engaged ( ) & & prop . setter - > is_beta ) | |
( prop . getter . is_engaged ( ) & & prop . getter - > is_beta ) )
mono-docs: Merge Property and getter/setter docs
Summary:
Property docs, when present, should always be included in Property and Accessor
(setter and getter) docs.
Accessor docs, when present, should be included in their accessor method, and
also in the property method, as a side note.
This patch does just that.
Depends on D10285
Ref T8309
Test Plan: Generate docs and take a look at `Efl.Ui.Calendar`, for example, which has a bit of everything.
Reviewers: lauromoura
Reviewed By: lauromoura
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8309
Differential Revision: https://phab.enlightenment.org/D10298
2019-10-09 07:18:14 -07:00
text + = BETA_PROPERTY_REMARK ;
2019-07-23 11:58:42 -07:00
}
mono-docs: Merge Property and getter/setter docs
Summary:
Property docs, when present, should always be included in Property and Accessor
(setter and getter) docs.
Accessor docs, when present, should be included in their accessor method, and
also in the property method, as a side note.
This patch does just that.
Depends on D10285
Ref T8309
Test Plan: Generate docs and take a look at `Efl.Ui.Calendar`, for example, which has a bit of everything.
Reviewers: lauromoura
Reviewed By: lauromoura
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8309
Differential Revision: https://phab.enlightenment.org/D10298
2019-10-09 07:18:14 -07:00
if ( ! generate_tag_summary ( sink , text , context ) )
return false ;
2019-02-19 04:29:09 -08:00
mono-docs: Merge Property and getter/setter docs
Summary:
Property docs, when present, should always be included in Property and Accessor
(setter and getter) docs.
Accessor docs, when present, should be included in their accessor method, and
also in the property method, as a side note.
This patch does just that.
Depends on D10285
Ref T8309
Test Plan: Generate docs and take a look at `Efl.Ui.Calendar`, for example, which has a bit of everything.
Reviewers: lauromoura
Reviewed By: lauromoura
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8309
Differential Revision: https://phab.enlightenment.org/D10298
2019-10-09 07:18:14 -07:00
text = " " ;
2019-02-19 04:29:09 -08:00
if ( prop . setter . is_engaged ( ) )
text = prop . setter - > parameters [ 0 ] . documentation . full_text ;
else if ( prop . getter . is_engaged ( ) )
text = prop . getter - > return_documentation . full_text ;
// If there are no docs at all, do not generate <value> tag
mono-docs: Allow embedding external examples
Summary:
New option added to eolian_gen: -e <dir>
This specifies a directory to search for examples. If a file is found with the
same name as an EFL C# class (e.g. Efl.Ui.Button.cs) or as an EFL C# method or
property (e.g. Efl.IText.Text.cs, Efl.IText.SetText.cs) its full
contents will be embedded in the documentation for that class or method within
<example> and <code> tags. This is, in turn, is parsed by DocFX and shown
in Example boxes in the generated pages.
If an example file is not found, no examples are embedded for that object.
If -e is not used, no examples are embedded for any object.
New option added to meson: mono-examples-dir to point to the examples directory.
This directory is then passed to eolian_mono through -e.
Do not use it (or define it to nothing) to disable example embedding.
No performance drop has been observed because of these extra tests.
Right now examples can only be given for base classes, not for derived ones
(i.e. Efl.IText.Text but not Efl.Ui.Button.Text). This will be addressed in a
later commit.
Feature
Depends on D8587
Test Plan:
Create an examples folder and put some files in it:
```
mkdir /tmp/examples
echo 'var button = new Efl.Ui.Button();' > /tmp/examples/Efl.Ui.Button.cs
echo 'button.AutoRepeatEnabled = true;' > /tmp/examples/Efl.Ui.IAutorepeat.AutorepeatEnabled.cs
echo 'button.SetAutoRepeatEnabled(true);' > /tmp/examples/Efl.Ui.IAutorepeat.SetAutorepeatEnabled.cs
```
Configure meson to embed examples and build:
```
meson configure -Dmono-examples-dir=/tmp/examples
ninja
```
Examine the generated efl_ui_button.eo.cs file to see embedded <example> tags,
or run DocFX and bask in the glory of documentation pages with examples:
```
cd doc/docfx
./gendoc.sh
```
Reviewers: lauromoura, felipealmeida, vitor.sousa, zmike, bu5hm4n
Reviewed By: vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D8592
2019-04-11 01:38:40 -07:00
if ( ! text . empty ( ) )
if ( ! generate_tag_value ( sink , text , context ) ) return false ;
2019-02-19 04:29:09 -08:00
2019-04-11 03:40:21 -07:00
return generate_all_tag_examples ( sink ,
name_helpers : : klass_full_concrete_or_interface_name ( prop . klass ) ,
name_helpers : : property_managed_name ( prop ) ,
context ) ;
2019-02-19 04:29:09 -08:00
}
2017-12-06 16:03:55 -08:00
template < typename OutputIterator , typename Context >
bool generate ( OutputIterator sink , attributes : : function_def const & func , Context const & context ) const
{
if ( func . type = = attributes : : function_type : : prop_get | | func . type = = attributes : : function_type : : prop_set )
return generate_property ( sink , func , context ) ;
else
return generate_function ( sink , func , context ) ;
return true ;
}
template < typename OutputIterator , typename Context >
bool generate_property ( OutputIterator sink , attributes : : function_def const & func , Context const & context ) const
{
mono-docs: Merge Property and getter/setter docs
Summary:
Property docs, when present, should always be included in Property and Accessor
(setter and getter) docs.
Accessor docs, when present, should be included in their accessor method, and
also in the property method, as a side note.
This patch does just that.
Depends on D10285
Ref T8309
Test Plan: Generate docs and take a look at `Efl.Ui.Calendar`, for example, which has a bit of everything.
Reviewers: lauromoura
Reviewed By: lauromoura
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8309
Differential Revision: https://phab.enlightenment.org/D10298
2019-10-09 07:18:14 -07:00
if ( ! func . documentation . full_text . empty ( ) | |
! func . property_documentation . full_text . empty ( ) )
2017-12-06 16:03:55 -08:00
{
mono-docs: Merge Property and getter/setter docs
Summary:
Property docs, when present, should always be included in Property and Accessor
(setter and getter) docs.
Accessor docs, when present, should be included in their accessor method, and
also in the property method, as a side note.
This patch does just that.
Depends on D10285
Ref T8309
Test Plan: Generate docs and take a look at `Efl.Ui.Calendar`, for example, which has a bit of everything.
Reviewers: lauromoura
Reviewed By: lauromoura
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8309
Differential Revision: https://phab.enlightenment.org/D10298
2019-10-09 07:18:14 -07:00
// Generate docs by merging Property, Accessor, Since and Beta pieces.
std : : string text = func . property_documentation . full_text ;
if ( ! func . property_documentation . since . empty ( ) )
text + = " \\ <br/ \\ > \n Since EFL " + func . property_documentation . since + " . " ;
if ( ! func . documentation . full_text . empty ( ) )
text + = " \\ <br/ \\ > \n \\ <b \\ >Note: \\ </b \\ > " + func . documentation . full_text ;
if ( ! func . klass . is_beta & & func . is_beta )
text + = BETA_METHOD_REMARK ;
if ( ! generate_tag_summary ( sink , text , context ) )
2017-12-06 16:03:55 -08:00
return false ;
}
for ( auto & & param : func . parameters )
if ( ! generate_parameter ( sink , param , context ) )
return false ;
2018-12-21 05:52:11 -08:00
if ( ! generate_tag_return ( sink , func . return_documentation . full_text , context ) )
2017-12-06 16:03:55 -08:00
return false ;
2019-04-11 03:40:21 -07:00
return generate_all_tag_examples ( sink ,
name_helpers : : klass_full_concrete_or_interface_name ( func . klass ) ,
2019-04-23 03:19:09 -07:00
name_helpers : : managed_method_name ( func ) ,
2019-04-11 03:40:21 -07:00
context ) ;
2017-12-06 16:03:55 -08:00
}
template < typename OutputIterator , typename Context >
bool generate_function ( OutputIterator sink , attributes : : function_def const & func , Context const & context ) const
{
2019-07-23 11:58:42 -07:00
std : : string tail_text = " " ;
if ( ! func . klass . is_beta & & func . is_beta )
{
tail_text = BETA_METHOD_REMARK ;
}
if ( ! generate ( sink , func . documentation , context , tail_text ) )
2017-12-06 16:03:55 -08:00
return false ;
for ( auto & & param : func . parameters )
if ( ! generate_parameter ( sink , param , context ) )
return false ;
2018-12-21 05:52:11 -08:00
if ( ! generate_tag_return ( sink , func . return_documentation . full_text , context ) )
2017-12-06 16:03:55 -08:00
return false ;
2019-04-11 03:40:21 -07:00
return generate_all_tag_examples ( sink ,
name_helpers : : klass_full_concrete_or_interface_name ( func . klass ) ,
2019-04-23 03:19:09 -07:00
name_helpers : : managed_method_name ( func ) ,
2019-04-11 03:40:21 -07:00
context ) ;
2017-12-06 16:03:55 -08:00
}
template < typename OutputIterator , typename Context >
bool generate_parameter ( OutputIterator sink , attributes : : parameter_def const & param , Context const & context ) const
{
2019-09-20 07:05:01 -07:00
auto text = param . documentation . full_text ;
if ( param . default_value . is_engaged ( ) )
{
auto value = param . default_value - > serialized ;
if ( param . default_value - > is_name_ref )
{
value = name_helpers : : full_managed_name ( value ) ;
text + = " \\ <br/ \\ >The default value is \\ <see cref= \\ \" " + value + " \\ \" / \\ >. " ;
}
else
{
text + = " \\ <br/ \\ >The default value is \\ <c \\ > " + value + " \\ </c \\ >. " ;
}
}
return generate_tag_param ( sink , name_helpers : : escape_keyword ( param . param_name ) , text , context ) ;
2017-12-06 16:03:55 -08:00
}
template < typename OutputIterator , typename Context >
2019-07-23 11:58:42 -07:00
bool generate ( OutputIterator sink , attributes : : documentation_def const & doc , Context const & context , std : : string tail_text = " " ) const
2017-12-06 16:03:55 -08:00
{
2019-03-20 02:47:22 -07:00
std : : string str = doc . full_text ;
if ( ! doc . since . empty ( ) )
2019-10-03 23:46:29 -07:00
str + = " \\ <br/ \\ >Since EFL " + doc . since + " . " ;
2019-07-23 11:58:42 -07:00
str + = tail_text ;
2019-03-20 02:47:22 -07:00
return generate_tag_summary ( sink , str , context ) ;
2017-12-06 16:03:55 -08:00
}
2019-02-01 11:03:02 -08:00
template < typename OutputIterator , typename Context >
bool generate ( OutputIterator sink , attributes : : constructor_def const & ctor , Context const & context ) const
{
// Not sure if this is the best way to generate a reference outside the full doc generator.
auto unit = ( const Eolian_Unit * ) context_find_tag < eolian_state_context > ( context ) . state ;
auto func = ctor . function ;
auto eolian_klass = get_klass ( func . klass , unit ) ;
attributes : : klass_def klass ( eolian_klass , unit ) ;
std : : string summary ;
if ( func . type = = attributes : : function_type : : prop_set )
summary = func . property_documentation . summary ;
else
summary = func . documentation . summary ;
for ( auto & & param : ctor . function . parameters )
{
2019-07-11 01:19:52 -07:00
auto ref = function_conversion ( func ) ;
if ( ! context_find_tag < options_context > ( context ) . want_beta & & func . is_beta )
{
ref + = BETA_REF_SUFFIX ;
ref = " <span class= \" text-muted \" > " + ref + " </span> " ;
}
else
ref = " <see cref= \" " + ref + " \" /> " ;
2019-09-23 16:50:27 -07:00
if ( ! as_generator ( scope_tab ( scope_size ) < < " /// <param name= \" " < < constructor_parameter_name ( ctor ) < < " \" > " < < summary < < " See " < < ref < < " </param> \n " )
. generate ( sink , param , context ) )
2019-02-01 11:03:02 -08:00
return false ;
}
return true ;
}
2017-12-06 16:03:55 -08:00
} ;
struct documentation_terminal
{
documentation_generator operator ( ) ( int n ) const
{
return documentation_generator ( n ) ;
}
} const documentation = { } ;
documentation_generator as_generator ( documentation_terminal )
{
return documentation_generator ( 0 ) ;
}
2019-08-01 12:12:12 -07:00
/// Escape a single string, HTML-escaping and converting the syntax
struct documentation_string_generator
{
template < typename OutputIterator , typename Context >
bool generate ( OutputIterator sink , std : : string const & text , Context const & context ) const
{
std : : string escaped ;
if ( ! as_generator ( html_escaped_string ) . generate ( std : : back_inserter ( escaped ) , text , context ) )
return false ;
auto options = context_find_tag < options_context > ( context ) ;
auto state = context_find_tag < eolian_state_context > ( context ) . state ;
if ( ! as_generator ( string ) . generate ( sink , documentation_generator : : syntax_conversion ( escaped , state , options . want_beta ) , context ) )
return false ;
return true ;
}
} const documentation_string { } ;
2017-12-06 16:03:55 -08:00
} // namespace eolian_mono
namespace efl { namespace eolian { namespace grammar {
template < >
struct is_eager_generator < : : eolian_mono : : documentation_generator > : std : : true_type { } ;
template < >
struct is_generator < : : eolian_mono : : documentation_generator > : std : : true_type { } ;
2019-08-01 12:12:12 -07:00
template < >
struct is_eager_generator < : : eolian_mono : : documentation_string_generator > : std : : true_type { } ;
template < >
struct is_generator < : : eolian_mono : : documentation_string_generator > : std : : true_type { } ;
2017-12-06 16:03:55 -08:00
template < >
struct is_generator < : : eolian_mono : : documentation_terminal > : std : : true_type { } ;
namespace type_traits {
template < >
struct attributes_needed < struct : : eolian_mono : : documentation_generator > : std : : integral_constant < int , 1 > { } ;
template < >
struct attributes_needed < struct : : eolian_mono : : documentation_terminal > : std : : integral_constant < int , 1 > { } ;
2019-08-01 12:12:12 -07:00
template < >
struct attributes_needed < struct : : eolian_mono : : documentation_string_generator > : std : : integral_constant < int , 1 > { } ;
2017-12-06 16:03:55 -08:00
}
} } }
# endif
