2017-05-06 22:12:33 +00:00
<!DOCTYPE html>
< html >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title >
Class: Sapling::CLI
— Sapling Documentation
< / title >
< link rel = "stylesheet" href = "../css/style.css" type = "text/css" charset = "utf-8" / >
< link rel = "stylesheet" href = "../css/common.css" type = "text/css" charset = "utf-8" / >
< script type = "text/javascript" charset = "utf-8" >
pathId = "Sapling::CLI";
relpath = '../';
< / script >
< script type = "text/javascript" charset = "utf-8" src = "../js/jquery.js" > < / script >
< script type = "text/javascript" charset = "utf-8" src = "../js/app.js" > < / script >
< / head >
< body >
< div class = "nav_wrap" >
< iframe id = "nav" src = "../class_list.html?1" > < / iframe >
< div id = "resizer" > < / div >
< / div >
< div id = "main" tabindex = "-1" >
< div id = "header" >
< div id = "menu" >
< a href = "../_index.html" > Index (C)< / a > »
< span class = 'title' > < span class = 'object_link' > < a href = "../Sapling.html" title = "Sapling (module)" > Sapling< / a > < / span > < / span >
»
< span class = "title" > CLI< / span >
< / div >
< div id = "search" >
< a class = "full_list_link" id = "class_list_link"
href="../class_list.html">
< svg width = "24" height = "24" >
< rect x = "0" y = "4" width = "24" height = "4" rx = "1" ry = "1" > < / rect >
< rect x = "0" y = "12" width = "24" height = "4" rx = "1" ry = "1" > < / rect >
< rect x = "0" y = "20" width = "24" height = "4" rx = "1" ry = "1" > < / rect >
< / svg >
< / a >
< / div >
< div class = "clear" > < / div >
< / div >
< div id = "content" > < h1 > Class: Sapling::CLI
< / h1 >
< div class = "box_info" >
< dl >
< dt > Inherits:< / dt >
< dd >
< span class = "inheritName" > Object< / span >
< ul class = "fullTree" >
< li > Object< / li >
< li class = "next" > Sapling::CLI< / li >
< / ul >
< a href = "#" class = "inheritanceTree" > show all< / a >
< / dd >
< / dl >
< dl >
< dt > Defined in:< / dt >
< dd > lib/sapling.rb< / dd >
< / dl >
< / div >
< h2 > Overview< / h2 > < div class = "docstring" >
< div class = "discussion" >
2017-05-07 20:59:34 +00:00
< p > CLI is the class for option parsing, and the gateway to the program, on the
command line< / p >
2017-05-06 22:12:33 +00:00
< / div >
< / div >
< div class = "tags" >
< / div >
< h2 >
Instance Method Summary
< small > < a href = "#" class = "summary_toggle" > collapse< / a > < / small >
< / h2 >
< ul class = "summary" >
< li class = "public " >
< span class = "summary_signature" >
< a href = "#talk-instance_method" title = "#talk (instance method)" > #< strong > talk< / strong > (options) ⇒ Object < / a >
< / span >
< span class = "summary_desc" > < div class = 'inline' >
< p > Option parsing, and gateway to either reading and traversing a tree, or
editing/creating a tree.< / p >
< / div > < / span >
< / li >
< / ul >
< div id = "instance_method_details" class = "method_details_list" >
< h2 > Instance Method Details< / h2 >
< div class = "method_details first" >
< h3 class = "signature first" id = "talk-instance_method" >
#< strong > talk< / strong > (options) ⇒ < tt > Object< / tt >
< / h3 > < div class = "docstring" >
< div class = "discussion" >
< p > Option parsing, and gateway to either reading and traversing a tree, or
editing/creating a tree.< / p >
< / div >
< / div >
< div class = "tags" >
< / div > < table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
2017-05-07 20:59:34 +00:00
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82< / pre >
2017-05-06 22:12:33 +00:00
< / td >
< td >
2017-05-07 20:59:34 +00:00
< pre class = "code" > < span class = "info file" > # File 'lib/sapling.rb', line 21< / span >
2017-05-06 22:12:33 +00:00
< span class = 'kw' > def< / span > < span class = 'id identifier rubyid_talk' > talk< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_options' > options< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_opt_parser' > opt_parser< / span > < span class = 'op' > =< / span > < span class = 'const' > OptionParser< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_new' > new< / span > < span class = 'kw' > do< / span > < span class = 'op' > |< / span > < span class = 'id identifier rubyid_opt' > opt< / span > < span class = 'op' > |< / span >
< span class = 'id identifier rubyid_opt' > opt< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_banner' > banner< / span > < span class = 'op' > =< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Usage: sapling -t FILE\n< / span > < span class = 'tstring_end' > " < / span > < / span > \
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Usage: sapling -e [FILE]< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'id identifier rubyid_opt' > opt< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_on_tail' > on_tail< / span > < span class = 'lparen' > (< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > -h< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'comma' > ,< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > --help< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'comma' > ,< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Show this menu< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rparen' > )< / span > < span class = 'kw' > do< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'id identifier rubyid_opt' > opt< / span >
< span class = 'id identifier rubyid_exit' > exit< / span >
< span class = 'kw' > end< / span >
< span class = 'id identifier rubyid_opt' > opt< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_on' > on< / span > < span class = 'lparen' > (< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > -t< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'comma' > ,< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > --talk< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'comma' > ,< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Begin traversing the provided dialogue tree< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rparen' > )< / span > < span class = 'kw' > do< / span >
< span class = 'kw' > if< / span > < span class = 'const' > ARGV< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_empty?' > empty?< / span >
2017-05-07 20:59:34 +00:00
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > No tree file provided. Please provide a tree file.< / span > < span class = 'tstring_end' > " < / span > < / span >
2017-05-06 22:12:33 +00:00
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'id identifier rubyid_opt_parser' > opt_parser< / span >
< span class = 'id identifier rubyid_exit' > exit< / span >
< span class = 'kw' > end< / span >
2017-05-07 20:59:34 +00:00
< span class = 'kw' > unless< / span > < span class = 'id identifier rubyid_verify_tree' > < span class = 'object_link' > < a href = "../top-level-namespace.html#verify_tree-instance_method" title = "#verify_tree (method)" > verify_tree< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'const' > ARGV< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 0< / span > < span class = 'rbracket' > ]< / span > < span class = 'rparen' > )< / span >
2017-05-06 22:12:33 +00:00
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > \n< / span > < span class = 'embexpr_beg' > #{< / span > < span class = 'id identifier rubyid_opt' > opt< / span > < span class = 'embexpr_end' > }< / span > < span class = 'tstring_content' > \n< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'id identifier rubyid_exit' > exit< / span >
< span class = 'kw' > end< / span >
2017-05-07 20:59:34 +00:00
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Welcome to Sapling, a Dialogue Tree Utility.\n< / span > < span class = 'tstring_end' > " < / span > < / span >
2017-05-06 22:12:33 +00:00
< span class = 'id identifier rubyid_speaker' > speaker< / span > < span class = 'op' > =< / span > < span class = 'const' > < span class = 'object_link' > < a href = "../Dialogue.html" title = "Dialogue (module)" > Dialogue< / a > < / span > < / span > < span class = 'op' > ::< / span > < span class = 'const' > < span class = 'object_link' > < a href = "../Dialogue/Speaker.html" title = "Dialogue::Speaker (class)" > Speaker< / a > < / span > < / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_new' > < span class = 'object_link' > < a href = "../Dialogue/Speaker.html#initialize-instance_method" title = "Dialogue::Speaker#initialize (method)" > new< / a > < / span > < / span >
2017-05-07 20:59:34 +00:00
< span class = 'id identifier rubyid_speaker' > speaker< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_file' > file< / span > < span class = 'op' > =< / span > < span class = 'const' > YAML< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_load_file' > load_file< / span > < span class = 'lparen' > (< / span > < span class = 'const' > ARGV< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 0< / span > < span class = 'rbracket' > ]< / span > < span class = 'rparen' > )< / span >
2017-05-06 22:12:33 +00:00
< span class = 'id identifier rubyid_speaker' > speaker< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_conversation' > conversation< / span >
< span class = 'kw' > end< / span >
< span class = 'id identifier rubyid_opt' > opt< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_on' > on< / span > < span class = 'lparen' > (< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > -e< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'comma' > ,< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > --edit< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'comma' > ,< / span >
< span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Create or edit a dialogue tree< / span > < span class = 'tstring_end' > " < / span > < / span > < span class = 'rparen' > )< / span > < span class = 'kw' > do< / span >
2017-05-07 20:59:34 +00:00
< span class = 'kw' > if< / span > < span class = 'const' > ARGV< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_empty?' > empty?< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Creating a new tree.< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'op' > =< / span > < span class = 'const' > < span class = 'object_link' > < a href = "../top-level-namespace.html#SKELETON_TREE-constant" title = "SKELETON_TREE (constant)" > SKELETON_TREE< / a > < / span > < / span >
< span class = 'kw' > else< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Using tree at < / span > < span class = 'embexpr_beg' > #{< / span > < span class = 'const' > ARGV< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 0< / span > < span class = 'rbracket' > ]< / span > < span class = 'embexpr_end' > }< / span > < span class = 'tstring_content' > .< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'kw' > unless< / span > < span class = 'id identifier rubyid_verify_tree' > < span class = 'object_link' > < a href = "../top-level-namespace.html#verify_tree-instance_method" title = "#verify_tree (method)" > verify_tree< / a > < / span > < / span > < span class = 'lparen' > (< / span > < span class = 'const' > ARGV< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 0< / span > < span class = 'rbracket' > ]< / span > < span class = 'rparen' > )< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > \n< / span > < span class = 'embexpr_beg' > #{< / span > < span class = 'id identifier rubyid_opt' > opt< / span > < span class = 'embexpr_end' > }< / span > < span class = 'tstring_content' > \n< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'id identifier rubyid_exit' > exit< / span >
< span class = 'kw' > end< / span >
< span class = 'id identifier rubyid_tree' > tree< / span > < span class = 'op' > =< / span > < span class = 'const' > YAML< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_load_file' > load_file< / span > < span class = 'lparen' > (< / span > < span class = 'const' > ARGV< / span > < span class = 'lbracket' > [< / span > < span class = 'int' > 0< / span > < span class = 'rbracket' > ]< / span > < span class = 'rparen' > )< / span >
< span class = 'kw' > end< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Welcome to Sapling, a Dialogue Tree Utility.\n< / span > < span class = 'tstring_end' > " < / span > < / span >
< span class = 'id identifier rubyid_gardner' > gardner< / span > < span class = 'op' > =< / span > < span class = 'const' > < span class = 'object_link' > < a href = "../Planter.html" title = "Planter (module)" > Planter< / a > < / span > < / span > < span class = 'op' > ::< / span > < span class = 'const' > < span class = 'object_link' > < a href = "../Planter/Spade.html" title = "Planter::Spade (class)" > Spade< / a > < / span > < / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_new' > new< / span >
< span class = 'id identifier rubyid_gardner' > gardner< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_file' > file< / span > < span class = 'op' > =< / span > < span class = 'id identifier rubyid_tree' > tree< / span >
< span class = 'id identifier rubyid_gardner' > gardner< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_plant' > plant< / span >
2017-05-06 22:12:33 +00:00
< span class = 'kw' > end< / span >
< span class = 'kw' > end< / span >
2017-05-07 20:59:34 +00:00
< span class = 'comment' > # Hacky way of dealing with bad options
< / span > < span class = 'kw' > begin< / span >
< span class = 'id identifier rubyid_opt_parser' > opt_parser< / span > < span class = 'period' > .< / span > < span class = 'id identifier rubyid_parse!' > parse!< / span > < span class = 'lparen' > (< / span > < span class = 'id identifier rubyid_options' > options< / span > < span class = 'rparen' > )< / span >
< span class = 'kw' > rescue< / span > < span class = 'const' > OptionParser< / span > < span class = 'op' > ::< / span > < span class = 'const' > InvalidOption< / span >
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'tstring' > < span class = 'tstring_beg' > " < / span > < span class = 'tstring_content' > Invalid option.< / span > < span class = 'tstring_end' > " < / span > < / span >
2017-05-06 22:12:33 +00:00
< span class = 'id identifier rubyid_puts' > puts< / span > < span class = 'id identifier rubyid_opt_parser' > opt_parser< / span >
< span class = 'id identifier rubyid_exit' > exit< / span >
< span class = 'kw' > end< / span >
< span class = 'kw' > end< / span > < / pre >
< / td >
< / tr >
< / table >
< / div >
< / div >
< / div >
< div id = "footer" >
2017-05-07 20:59:34 +00:00
Generated on Sun May 7 16:58:49 2017 by
2017-05-06 22:12:33 +00:00
< a href = "http://yardoc.org" title = "Yay! A Ruby Documentation Tool" target = "_parent" > yard< / a >
0.9.9 (ruby-2.2.5).
< / div >
< / div >
< / body >
< / html >
