Class: Jazzy::SourceDeclaration

Inherits:
Object
  • Object
show all
Defined in:
lib/jazzy/source_declaration.rb,
lib/jazzy/source_declaration/type.rb,
lib/jazzy/source_declaration/access_control_level.rb

Direct Known Subclasses

SourceDocument

Defined Under Namespace

Classes: AccessControlLevel, Type

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#abstract ⇒ Object

Returns the value of attribute abstract.



120
121
122
 
# File 'lib/jazzy/source_declaration.rb', line 120

def abstract
  @abstract
end

#access_control_level ⇒ Object

Returns the value of attribute access_control_level.



128
129
130
 
# File 'lib/jazzy/source_declaration.rb', line 128

def access_control_level
  @access_control_level
end

#children ⇒ Object

counterpart of parent_in_docs



42
43
44
 
# File 'lib/jazzy/source_declaration.rb', line 42

def children
  @children
end

#column ⇒ Object

Returns the value of attribute column.



112
113
114
 
# File 'lib/jazzy/source_declaration.rb', line 112

def column
  @column
end

#declaration ⇒ Object

Returns the value of attribute declaration.



118
119
120
 
# File 'lib/jazzy/source_declaration.rb', line 118

def declaration
  @declaration
end

#default_impl_abstract ⇒ Object

Returns the value of attribute default_impl_abstract.



121
122
123
 
# File 'lib/jazzy/source_declaration.rb', line 121

def default_impl_abstract
  @default_impl_abstract
end

#deprecated ⇒ Object

Returns the value of attribute deprecated.



133
134
135
 
# File 'lib/jazzy/source_declaration.rb', line 133

def deprecated
  @deprecated
end

#deprecation_message ⇒ Object

Returns the value of attribute deprecation_message.



134
135
136
 
# File 'lib/jazzy/source_declaration.rb', line 134

def deprecation_message
  @deprecation_message
end

#discussion ⇒ Object

Returns the value of attribute discussion.



123
124
125
 
# File 'lib/jazzy/source_declaration.rb', line 123

def discussion
  @discussion
end

#end_line ⇒ Object

Returns the value of attribute end_line.



130
131
132
 
# File 'lib/jazzy/source_declaration.rb', line 130

def end_line
  @end_line
end

#file ⇒ Object

Returns the value of attribute file.



110
111
112
 
# File 'lib/jazzy/source_declaration.rb', line 110

def file
  @file
end

#from_protocol_extension ⇒ Object

Returns the value of attribute from_protocol_extension.



122
123
124
 
# File 'lib/jazzy/source_declaration.rb', line 122

def from_protocol_extension
  @from_protocol_extension
end

#generic_requirements ⇒ Object

Returns the value of attribute generic_requirements.



137
138
139
 
# File 'lib/jazzy/source_declaration.rb', line 137

def generic_requirements
  @generic_requirements
end

#inherited_types ⇒ Object

Returns the value of attribute inherited_types.



138
139
140
 
# File 'lib/jazzy/source_declaration.rb', line 138

def inherited_types
  @inherited_types
end

#line ⇒ Object

Returns the value of attribute line.



111
112
113
 
# File 'lib/jazzy/source_declaration.rb', line 111

def line
  @line
end

#mark ⇒ Object

Returns the value of attribute mark.



127
128
129
 
# File 'lib/jazzy/source_declaration.rb', line 127

def mark
  @mark
end

#modulename ⇒ Object

Returns the value of attribute modulename.



115
116
117
 
# File 'lib/jazzy/source_declaration.rb', line 115

def modulename
  @modulename
end

#name ⇒ Object

Returns the value of attribute name.



116
117
118
 
# File 'lib/jazzy/source_declaration.rb', line 116

def name
  @name
end

#nav_order ⇒ Object

Returns the value of attribute nav_order.



131
132
133
 
# File 'lib/jazzy/source_declaration.rb', line 131

def nav_order
  @nav_order
end

#objc_name ⇒ Object

Returns the value of attribute objc_name.



117
118
119
 
# File 'lib/jazzy/source_declaration.rb', line 117

def objc_name
  @objc_name
end

#other_language_declaration ⇒ Object

Returns the value of attribute other_language_declaration.



119
120
121
 
# File 'lib/jazzy/source_declaration.rb', line 119

def other_language_declaration
  @other_language_declaration
end

#parameters ⇒ Object

Returns the value of attribute parameters.



125
126
127
 
# File 'lib/jazzy/source_declaration.rb', line 125

def parameters
  @parameters
end

#parent_in_code ⇒ Object

Element containing this declaration in the code



35
36
37
 
# File 'lib/jazzy/source_declaration.rb', line 35

def parent_in_code
  @parent_in_code
end

#parent_in_docs ⇒ Object

Logical parent in the documentation. May differ from parent_in_code because of top-level categories and merged extensions.



39
40
41
 
# File 'lib/jazzy/source_declaration.rb', line 39

def parent_in_docs
  @parent_in_docs
end

#return ⇒ Object

Returns the value of attribute return.



124
125
126
 
# File 'lib/jazzy/source_declaration.rb', line 124

def return
  @return
end

#start_line ⇒ Object

Returns the value of attribute start_line.



129
130
131
 
# File 'lib/jazzy/source_declaration.rb', line 129

def start_line
  @start_line
end

#type ⇒ Object

kind of declaration (e.g. class, variable, function)



8
9
10
 
# File 'lib/jazzy/source_declaration.rb', line 8

def type
  @type
end

#type_usr ⇒ Object

Returns the value of attribute type_usr.



114
115
116
 
# File 'lib/jazzy/source_declaration.rb', line 114

def type_usr
  @type_usr
end

#typename ⇒ Object

static type of declared element (e.g. String.Type -> ())



10
11
12
 
# File 'lib/jazzy/source_declaration.rb', line 10

def typename
  @typename
end

#unavailable ⇒ Object

Returns the value of attribute unavailable.



135
136
137
 
# File 'lib/jazzy/source_declaration.rb', line 135

def unavailable
  @unavailable
end

#unavailable_message ⇒ Object

Returns the value of attribute unavailable_message.



136
137
138
 
# File 'lib/jazzy/source_declaration.rb', line 136

def unavailable_message
  @unavailable_message
end

#url ⇒ Object

Returns the value of attribute url.



126
127
128
 
# File 'lib/jazzy/source_declaration.rb', line 126

def url
  @url
end

#url_name ⇒ Object

Returns the value of attribute url_name.



132
133
134
 
# File 'lib/jazzy/source_declaration.rb', line 132

def url_name
  @url_name
end

#usr ⇒ Object

Returns the value of attribute usr.



113
114
115
 
# File 'lib/jazzy/source_declaration.rb', line 113

def usr
  @usr
end

Instance Method Details

#abstract_glob ⇒ Object 



200
201
202
203
204
205
 
# File 'lib/jazzy/source_declaration.rb', line 200

def abstract_glob
  return [] unless
    Config.instance.abstract_glob_configured &&
    Config.instance.abstract_glob
  Config.instance.abstract_glob.select { |e| File.file? e }
end

#alternative_abstract ⇒ Object 



187
188
189
190
191
 
# File 'lib/jazzy/source_declaration.rb', line 187

def alternative_abstract
  if file = alternative_abstract_file
    Pathname(file).read
  end
end

#alternative_abstract_file ⇒ Object 



193
194
195
196
197
198
 
# File 'lib/jazzy/source_declaration.rb', line 193

def alternative_abstract_file
  abstract_glob.select do |f|
    # allow Structs.md or Structures.md
    [name, url_name].include?(File.basename(f).split('.').first)
  end.first
end

#constrained_extension? ⇒ Boolean

Returns:

  • (Boolean) 


157
158
159
160
 
# File 'lib/jazzy/source_declaration.rb', line 157

def constrained_extension?
  type.swift_extension? &&
    generic_requirements
end

#display_declaration ⇒ Object 



99
100
101
102
103
 
# File 'lib/jazzy/source_declaration.rb', line 99

def display_declaration
  return declaration if swift?

  Config.instance.hide_objc? ? other_language_declaration : declaration
end

#display_language ⇒ Object

The language in the templates for display



93
94
95
96
97
 
# File 'lib/jazzy/source_declaration.rb', line 93

def display_language
  return 'Swift' if swift?

  Config.instance.hide_objc? ? 'Swift' : 'Objective-C'
end

#display_other_language_declaration ⇒ Object 



105
106
107
108
 
# File 'lib/jazzy/source_declaration.rb', line 105

def display_other_language_declaration
  other_language_declaration unless
    Config.instance.hide_objc? || Config.instance.hide_swift?
end

#docs_filename ⇒ Object

Base filename (no extension) for the item



149
150
151
152
153
154
155
 
# File 'lib/jazzy/source_declaration.rb', line 149

def docs_filename
  result = url_name || name
  # Workaround functions sharing names with
  # different argument types (f(a:Int) vs. f(a:String))
  return result unless type.swift_global_function?
  result + "_#{type_usr}"
end

#filepath ⇒ Object 



144
145
146
 
# File 'lib/jazzy/source_declaration.rb', line 144

def filepath
  CGI.unescape(url)
end

#fully_qualified_name ⇒ Object 



63
64
65
 
# File 'lib/jazzy/source_declaration.rb', line 63

def fully_qualified_name
  namespace_path.map(&:name).join('.')
end

#fully_qualified_name_regexp ⇒ Object

:name doesn’t include any generic type params. This regexp matches any generic type params in parent names.



69
70
71
72
73
 
# File 'lib/jazzy/source_declaration.rb', line 69

def fully_qualified_name_regexp
  Regexp.new(namespace_path.map(&:name)
                           .map { |n| Regexp.escape(n) }
                           .join('(?:<.*?>)?\.'))
end

#highlight_language ⇒ Object 



23
24
25
 
# File 'lib/jazzy/source_declaration.rb', line 23

def highlight_language
  swift? ? Highlighter::SWIFT : Highlighter::OBJC
end

#inherited_types? ⇒ Boolean

Returns:

  • (Boolean) 


170
171
172
173
 
# File 'lib/jazzy/source_declaration.rb', line 170

def inherited_types?
  inherited_types &&
    !inherited_types.empty?
end

#mark_for_children ⇒ Object 



162
163
164
165
166
167
168
 
# File 'lib/jazzy/source_declaration.rb', line 162

def mark_for_children
  if constrained_extension?
    SourceMark.new_generic_requirements(generic_requirements)
  else
    SourceMark.new
  end
end

#namespace_ancestors ⇒ Object 



55
56
57
58
59
60
61
 
# File 'lib/jazzy/source_declaration.rb', line 55

def namespace_ancestors
  if parent_in_code
    parent_in_code.namespace_path
  else
    []
  end
end

#namespace_path ⇒ Object

Chain of parent_in_code from top level to self. (Includes self.)



51
52
53
 
# File 'lib/jazzy/source_declaration.rb', line 51

def namespace_path
  namespace_ancestors + [self]
end

#objc_category_name ⇒ Object

If this declaration is an objc category, returns an array with the name of the extended objc class and the category name itself, i.e. [“NSString”, “MyMethods”], nil otherwise.



78
79
80
 
# File 'lib/jazzy/source_declaration.rb', line 78

def objc_category_name
  name.split(/[\(\)]/) if type.objc_category?
end

#omit_content_from_parent? ⇒ Boolean

When referencing this item from its parent category, include the content or just link to it directly?

Returns:

  • (Boolean) 


29
30
31
32
 
# File 'lib/jazzy/source_declaration.rb', line 29

def omit_content_from_parent?
  Config.instance.separate_global_declarations &&
    render_as_page?
end

#other_inherited_types?(unwanted) ⇒ Boolean

Is there at least one inherited type that is not in the given list?

Returns:

  • (Boolean) 


176
177
178
179
 
# File 'lib/jazzy/source_declaration.rb', line 176

def other_inherited_types?(unwanted)
  return false unless inherited_types?
  inherited_types.any? { |t| !unwanted.include?(t) }
end

#render_as_page? ⇒ Boolean

Give the item its own page or just inline into parent?

Returns:

  • (Boolean) 


13
14
15
16
17
 
# File 'lib/jazzy/source_declaration.rb', line 13

def render_as_page?
  children.any? ||
    (Config.instance.separate_global_declarations &&
     type.global?)
end

#swift? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/jazzy/source_declaration.rb', line 19

def swift?
  type.swift_type?
end

#swift_extension_objc_name ⇒ Object 



86
87
88
89
90
 
# File 'lib/jazzy/source_declaration.rb', line 86

def swift_extension_objc_name
  return unless type.swift_extension? && usr

  usr.split('(cs)').last
end

#swift_objc_extension? ⇒ Boolean

Returns:

  • (Boolean) 


82
83
84
 
# File 'lib/jazzy/source_declaration.rb', line 82

def swift_objc_extension?
  type.swift_extension? && usr && usr.start_with?('c:objc')
end

#type_from_doc_module? ⇒ Boolean

SourceKit only sets modulename for imported modules

Returns:

  • (Boolean) 


182
183
184
185
 
# File 'lib/jazzy/source_declaration.rb', line 182

def type_from_doc_module?
  !type.extension? ||
    (swift? && usr && modulename.nil?)
end

#usage_discouraged? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
 
# File 'lib/jazzy/source_declaration.rb', line 140

def usage_discouraged?
  unavailable || deprecated
end