/
z_module_indexer.html
109 lines (92 loc) · 6.32 KB
/
z_module_indexer.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Module z_module_indexer</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module z_module_indexer</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>Implements the module extension mechanisms for scomps, templates, actions etc.
<p>Copyright © 2009 Marc Worrell
Date: 2009-06-06
</p>
<p><b>Behaviours:</b> <a href="gen_server.html"><tt>gen_server</tt></a>.</p>
<p><b>Authors:</b> Marc Worrell (<a href="mailto:marc@worrell.nl"><tt>marc@worrell.nl</tt></a>).</p>
<h2><a name="description">Description</a></h2>Implements the module extension mechanisms for scomps, templates, actions etc. Scans all active modules
for scomps (etc) and maintains lookup lists for when the system tries to find a scomp (etc).
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#all-2">all/2</a></td><td>Return a list of all templates, scomps etc per module.</td></tr>
<tr><td valign="top"><a href="#code_change-3">code_change/3</a></td><td>Convert process state when code is changed.</td></tr>
<tr><td valign="top"><a href="#find-3">find/3</a></td><td>Find a scomp, validator etc.</td></tr>
<tr><td valign="top"><a href="#find_all-3">find_all/3</a></td><td>Find a scomp, validator etc.</td></tr>
<tr><td valign="top"><a href="#handle_call-3">handle_call/3</a></td><td>Find a template definition.</td></tr>
<tr><td valign="top"><a href="#handle_cast-2">handle_cast/2</a></td><td>Scan for all scomps etc.</td></tr>
<tr><td valign="top"><a href="#handle_info-2">handle_info/2</a></td><td>Handling all non call/cast messages.</td></tr>
<tr><td valign="top"><a href="#init-1">init/1</a></td><td>Initiates the server.</td></tr>
<tr><td valign="top"><a href="#reindex-1">reindex/1</a></td><td>Reindex the list of all scomps, etc for the site in the context.</td></tr>
<tr><td valign="top"><a href="#start_link-1">start_link/1</a></td><td>Starts the server.</td></tr>
<tr><td valign="top"><a href="#terminate-2">terminate/2</a></td><td>This function is called by a gen_server when it is about to
terminate.</td></tr>
<tr><td valign="top"><a href="#translations-1">translations/1</a></td><td>Find all .po files in all modules and the active site.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="all-2">all/2</a></h3>
<div class="spec">
<p><tt>all(What, Context) -> any()</tt></p>
</div><p>Return a list of all templates, scomps etc per module</p>
<h3 class="function"><a name="code_change-3">code_change/3</a></h3>
<div class="spec">
<p><tt>code_change(OldVsn, State, Extra) -> {ok, NewState}</tt><br></p>
</div><p>Convert process state when code is changed</p>
<h3 class="function"><a name="find-3">find/3</a></h3>
<div class="spec">
<p><tt>find(What, Name, Context) -> {ok, term()} | {error, Reason}</tt><br></p>
</div><p>Find a scomp, validator etc.</p>
<h3 class="function"><a name="find_all-3">find_all/3</a></h3>
<div class="spec">
<p><tt>find_all(What, Name, Context) -> list()</tt><br></p>
</div><p>Find a scomp, validator etc.</p>
<h3 class="function"><a name="handle_call-3">handle_call/3</a></h3>
<div class="spec">
<p><tt>handle_call(Message::Request, From, State) -> {reply, Reply, State} | {reply, Reply, State, Timeout} | {noreply, State} | {noreply, State, Timeout} | {stop, Reason, Reply, State} | {stop, Reason, State}</tt><br></p>
</div><p>Find a template definition</p>
<h3 class="function"><a name="handle_cast-2">handle_cast/2</a></h3>
<div class="spec">
<p><tt>handle_cast(Message::Msg, State) -> {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}</tt><br></p>
</div><p>Scan for all scomps etc. for the context given.</p>
<h3 class="function"><a name="handle_info-2">handle_info/2</a></h3>
<div class="spec">
<p><tt>handle_info(Info, State) -> {noreply, State} | {noreply, State, Timeout} | {stop, Reason, State}</tt><br></p>
</div><p>Handling all non call/cast messages</p>
<h3 class="function"><a name="init-1">init/1</a></h3>
<div class="spec">
<p><tt>init(SiteProps) -> {ok, State} | {ok, State, Timeout} | ignore | {stop, Reason}</tt><br></p>
</div><p>Initiates the server.</p>
<h3 class="function"><a name="reindex-1">reindex/1</a></h3>
<div class="spec">
<p><tt>reindex(Context) -> any()</tt></p>
</div><p>Reindex the list of all scomps, etc for the site in the context.</p>
<h3 class="function"><a name="start_link-1">start_link/1</a></h3>
<div class="spec">
<p><tt>start_link(SiteProps::Props) -> {ok, Pid} | ignore | {error, Error}</tt><br></p>
</div><p>Starts the server</p>
<h3 class="function"><a name="terminate-2">terminate/2</a></h3>
<div class="spec">
<p><tt>terminate(Reason, State) -> <a href="#type-void">void()</a></tt><br></p>
</div><p>This function is called by a gen_server when it is about to
terminate. It should be the opposite of Module:init/1 and do any necessary
cleaning up. When it returns, the gen_server terminates with Reason.
The return value is ignored.</p>
<h3 class="function"><a name="translations-1">translations/1</a></h3>
<div class="spec">
<p><tt>translations(Context::#context{}) -> [{module, {ModuleDirectory, [{Language, File}]}}]</tt><br></p>
</div><p>Find all .po files in all modules and the active site.
This is an active scan, not designed to be fast.</p>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Apr 11 2012, 20:41:28.</i></p>
</body>
</html>