Project creation, meta handling and more complete templating
This commit is contained in:
parent
a62eec74b7
commit
0b52119b3d
@ -34,7 +34,7 @@
|
||||
-export([do/0]).
|
||||
-export([subscribe/1, unsubscribe/0]).
|
||||
-export([list/0, list/1, list/2, list/3, latest/1]).
|
||||
-export([start/2, stop/1, stop/0]).
|
||||
-export([start/2, stop/1, stop/0, silent_stop/0]).
|
||||
|
||||
-export_type([serial/0, package_id/0, package/0, realm/0, name/0, version/0,
|
||||
identifier/0,
|
||||
@ -388,6 +388,24 @@ stop() ->
|
||||
end.
|
||||
|
||||
|
||||
-spec silent_stop() -> ok | {error, Reason :: term()}.
|
||||
%% @doc
|
||||
%% A safe wrapper for `application:stop(zx)'. Similar to `ensure_started/1,2', returns
|
||||
%% `ok' in the case that zx is already stopped.
|
||||
|
||||
silent_stop() ->
|
||||
ok = zx_daemon:idle(),
|
||||
case application:stop(zx) of
|
||||
ok ->
|
||||
init:stop();
|
||||
{error, {not_started, zx}} ->
|
||||
init:stop();
|
||||
Error ->
|
||||
ok = tell(error, "zx:stop_quiet/0 failed with ~tp", [Error]),
|
||||
init:stop(1)
|
||||
end.
|
||||
|
||||
|
||||
%%% Application Callbacks
|
||||
|
||||
-spec start(StartType, StartArgs) -> Result
|
||||
@ -685,8 +703,8 @@ make([Dep | Rest]) ->
|
||||
Error -> Error
|
||||
end;
|
||||
make([]) ->
|
||||
tell("Builds complete.").
|
||||
|
||||
ok.
|
||||
|
||||
|
||||
include_env(PackageID = {_, Name, _}) ->
|
||||
Path = filename:join(zx_lib:ppath(lib, PackageID), "include"),
|
||||
@ -745,7 +763,7 @@ fetch2(ID) ->
|
||||
|
||||
|
||||
-spec execute(Type, PackageID, Meta, Dir, RunArgs) -> no_return()
|
||||
when Type :: app | lib,
|
||||
when Type :: app | cli | gui | lib,
|
||||
PackageID :: package_id(),
|
||||
Meta :: package_meta(),
|
||||
Dir :: file:filename(),
|
||||
@ -754,19 +772,28 @@ fetch2(ID) ->
|
||||
%% Gets all the target application's ducks in a row and launches them, then enters
|
||||
%% the exec_wait/1 loop to wait for any queries from the application.
|
||||
|
||||
execute(app, PackageID, Meta, Dir, RunArgs) ->
|
||||
{ok, PackageString} = zx_lib:package_string(PackageID),
|
||||
ok = tell("Starting ~ts.", [PackageString]),
|
||||
Name = element(2, PackageID),
|
||||
ok = zx_daemon:pass_meta(Meta, Dir, RunArgs),
|
||||
AppTag = list_to_atom(Name),
|
||||
ok = ensure_all_started(AppTag),
|
||||
tell("Launcher complete.");
|
||||
execute(lib, PackageID, _, _, _) ->
|
||||
Message = "Lib ~ts is available on the system, but is not a standalone app.",
|
||||
{ok, PackageString} = zx_lib:package_string(PackageID),
|
||||
ok = tell(Message, [PackageString]),
|
||||
init:stop().
|
||||
init:stop();
|
||||
execute(cli, PackageID, Meta, Dir, RunArgs) ->
|
||||
Name = element(2, PackageID),
|
||||
ok = zx_daemon:pass_meta(Meta, Dir, RunArgs),
|
||||
AppTag = list_to_atom(Name),
|
||||
{ok, _} = application:ensure_all_started(AppTag),
|
||||
case maps:get(mod, Meta, none) of
|
||||
none -> {error, "No executable module"};
|
||||
Mod -> Mod:start(RunArgs)
|
||||
end;
|
||||
execute(Type, PackageID, Meta, Dir, RunArgs) ->
|
||||
{ok, PackageString} = zx_lib:package_string(PackageID),
|
||||
ok = tell("Starting ~p ~ts.", [Type, PackageString]),
|
||||
Name = element(2, PackageID),
|
||||
ok = zx_daemon:pass_meta(Meta, Dir, RunArgs),
|
||||
AppTag = list_to_atom(Name),
|
||||
ok = ensure_all_started(AppTag),
|
||||
tell("Launcher complete.").
|
||||
|
||||
|
||||
-spec ensure_all_started(AppMod) -> ok
|
||||
|
||||
@ -145,7 +145,7 @@
|
||||
-license("GPL-3.0").
|
||||
|
||||
-export([zomp_mode/0]).
|
||||
-export([pass_meta/3,
|
||||
-export([pass_meta/3, argv/0,
|
||||
subscribe/1, unsubscribe/1,
|
||||
list/0, list/1, list/2, list/3, latest/1,
|
||||
provides/2, list_deps/1,
|
||||
@ -178,7 +178,7 @@
|
||||
-record(s,
|
||||
{meta = none :: none | zx:package_meta(),
|
||||
home = none :: none | file:filename(),
|
||||
argv = none :: none | [string()],
|
||||
argv = [] :: [string()],
|
||||
conf = load_conf() :: conf(),
|
||||
id = 0 :: id(),
|
||||
actions = [] :: [request()],
|
||||
@ -350,6 +350,12 @@ pass_meta(Meta, Dir, ArgV) ->
|
||||
gen_server:cast(?MODULE, {pass_meta, Meta, Dir, ArgV}).
|
||||
|
||||
|
||||
-spec argv() -> [string()].
|
||||
|
||||
argv() ->
|
||||
gen_server:call(?MODULE, argv).
|
||||
|
||||
|
||||
-spec subscribe(Package) -> ok
|
||||
when Package :: zx:package().
|
||||
%% @doc
|
||||
@ -712,6 +718,8 @@ idle() ->
|
||||
%% @private
|
||||
%% gen_server callback for OTP calls
|
||||
|
||||
handle_call(argv, _, State = #s{argv = ArgV}) ->
|
||||
{reply, ArgV, State};
|
||||
handle_call({request, list}, _, State = #s{cx = CX}) ->
|
||||
Realms = cx_realms(CX),
|
||||
{reply, {ok, Realms}, State};
|
||||
|
||||
@ -44,9 +44,13 @@
|
||||
port = 11311 :: none | inet:port_number()}).
|
||||
|
||||
-record(project,
|
||||
{type = none :: none | app | lib | escript,
|
||||
{type = none :: none | app | lib | cli | gui | escript,
|
||||
license = none :: none | none | undefined | string(),
|
||||
name = none :: none | string(),
|
||||
desc = none :: none | string(),
|
||||
repo_url = none :: none | string(),
|
||||
ws_url = none :: none | string(),
|
||||
url = none :: none | string(),
|
||||
id = none :: none | zx:package_id() | zx:name(),
|
||||
prefix = none :: none | zx:lower0_9(),
|
||||
appmod = none :: none | zx:lower0_9(),
|
||||
@ -73,58 +77,155 @@ initialize() ->
|
||||
|
||||
initialize(P = #project{type = none}) ->
|
||||
initialize(P#project{type = ask_project_type()});
|
||||
initialize(P = #project{name = none}) ->
|
||||
initialize(P#project{name = ask_project_name()});
|
||||
initialize(P = #project{type = escript}) ->
|
||||
ok = tell(warning, "escripts cannot be initialized."),
|
||||
initialize(P#project{type = ask_project_type()});
|
||||
initialize(P = #project{type = app, id = none}) ->
|
||||
initialize(P = #project{type = lib, id = none}) ->
|
||||
initialize(P#project{id = ask_package_id()});
|
||||
initialize(P = #project{id = none}) ->
|
||||
ID = {_, AppMod, _} = ask_package_id(),
|
||||
initialize(P#project{id = ID, appmod = AppMod});
|
||||
initialize(P = #project{id = none}) ->
|
||||
initialize(P#project{id = ask_package_id()});
|
||||
initialize(P = #project{prefix = none}) ->
|
||||
initialize(P#project{prefix = ask_prefix()});
|
||||
initialize(P = #project{type = app, appmod = none}) ->
|
||||
initialize(P#project{appmod = ask_appmod()});
|
||||
initialize(P = #project{type = app,
|
||||
id = ID,
|
||||
prefix = Prefix,
|
||||
appmod = AppMod}) ->
|
||||
{ok, PS} = zx_lib:package_string(ID),
|
||||
Instructions =
|
||||
"~nAPPLICATION DATA CONFIRMATION~n"
|
||||
"[1] Type : application~n"
|
||||
"[2] Package ID : ~ts~n"
|
||||
"[3] Prefix : ~ts~n"
|
||||
"[4] AppMod : ~ts~n"
|
||||
"Press a number to select something to change, or [ENTER] to continue.~n",
|
||||
ok = io:format(Instructions, [PS, Prefix, AppMod]),
|
||||
case zx_tty:get_input() of
|
||||
"1" -> initialize(P#project{type = none});
|
||||
"2" -> initialize(P#project{id = none});
|
||||
"3" -> initialize(P#project{prefix = none});
|
||||
"4" -> initialize(P#project{appmod = none});
|
||||
"" -> initialize_check(P);
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
initialize(P)
|
||||
end;
|
||||
initialize(P = #project{type = lib,
|
||||
id = ID,
|
||||
prefix = Prefix}) ->
|
||||
initialize(P = #project{type = cli, appmod = none}) ->
|
||||
initialize(P#project{appmod = ask_appmod()});
|
||||
initialize(P = #project{type = gui, appmod = none}) ->
|
||||
initialize(P#project{appmod = ask_appmod()});
|
||||
initialize(P = #project{author = none, copyright = none}) ->
|
||||
{A, E} = ask_author(),
|
||||
initialize(P#project{author = A, a_email = E, copyright = A, c_email = E});
|
||||
initialize(P = #project{author = none}) ->
|
||||
{Author, Email} = ask_author(),
|
||||
initialize(P#project{author = Author, a_email = Email});
|
||||
initialize(P = #project{a_email = none}) ->
|
||||
initialize(P#project{a_email = ask_email_optional()});
|
||||
initialize(P = #project{copyright = none}) ->
|
||||
{Holder, Email} = ask_copyright(),
|
||||
initialize(P#project{copyright = Holder, c_email = Email});
|
||||
initialize(P = #project{c_email = none}) ->
|
||||
initialize(P#project{c_email = ask_email_optional()});
|
||||
initialize(P = #project{license = none}) ->
|
||||
initialize(P#project{license = ask_license()});
|
||||
initialize(P = #project{desc = none}) ->
|
||||
initialize(P#project{desc = ask_description()});
|
||||
initialize(P = #project{repo_url = none}) ->
|
||||
initialize(P#project{repo_url = ask_url(repo)});
|
||||
initialize(P = #project{ws_url = none}) ->
|
||||
initialize(P#project{ws_url = ask_url(website)});
|
||||
initialize(P = #project{type = lib,
|
||||
license = License,
|
||||
name = Name,
|
||||
id = ID,
|
||||
prefix = Prefix,
|
||||
author = Author,
|
||||
a_email = AEmail,
|
||||
copyright = CR,
|
||||
c_email = CEmail,
|
||||
repo_url = RepoURL,
|
||||
ws_url = WebsiteURL,
|
||||
desc = Desc}) ->
|
||||
{ok, PS} = zx_lib:package_string(ID),
|
||||
Instructions =
|
||||
"~nLIBRARY DATA CONFIRMATION~n"
|
||||
"[1] Type : library~n"
|
||||
"[2] Package ID : ~ts~n"
|
||||
"[3] Prefix : ~ts~n"
|
||||
"[ 1] Type : library~n"
|
||||
"[ 2] Project Name : ~ts~n"
|
||||
"[ 3] Package ID : ~ts~n"
|
||||
"[ 4] Author : ~ts~n"
|
||||
"[ 5] Author's Email : ~ts~n"
|
||||
"[ 6] Copyright Holder : ~ts~n"
|
||||
"[ 7] Copyright Holder's Email: ~ts~n"
|
||||
"[ 8] License : ~ts~n"
|
||||
"[ 9] Prefix : ~ts~n"
|
||||
"[10] Repo URL : ~ts~n"
|
||||
"[11] Website URL : ~ts~n"
|
||||
"[12] Description : ~ts~n"
|
||||
"Press a number to select something to change, or [ENTER] to continue.~n",
|
||||
ok = io:format(Instructions, [PS, Prefix]),
|
||||
ok = io:format(Instructions,
|
||||
[Name, PS,
|
||||
Author, AEmail,
|
||||
CR, CEmail,
|
||||
License, Prefix,
|
||||
RepoURL, WebsiteURL, Desc]),
|
||||
case zx_tty:get_input() of
|
||||
"1" -> initialize(P#project{type = none});
|
||||
"2" -> initialize(P#project{id = none});
|
||||
"3" -> initialize(P#project{prefix = none});
|
||||
"" -> initialize_check(P);
|
||||
_ ->
|
||||
"1" -> initialize(P#project{type = none});
|
||||
"2" -> initialize(P#project{name = none});
|
||||
"3" -> initialize(P#project{id = none});
|
||||
"4" -> initialize(P#project{author = none});
|
||||
"5" -> initialize(P#project{a_email = none});
|
||||
"6" -> initialize(P#project{copyright = none});
|
||||
"7" -> initialize(P#project{c_email = none});
|
||||
"8" -> initialize(P#project{license = none});
|
||||
"9" -> initialize(P#project{prefix = none});
|
||||
"10" -> initialize(P#project{repo_url = none});
|
||||
"11" -> initialize(P#project{ws_url = none});
|
||||
"12" -> initialize(P#project{desc = none});
|
||||
"" -> initialize_check(P);
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
initialize(P)
|
||||
end;
|
||||
initialize(P = #project{type = Type,
|
||||
license = License,
|
||||
name = Name,
|
||||
id = ID,
|
||||
prefix = Prefix,
|
||||
appmod = AppMod,
|
||||
author = Author,
|
||||
a_email = AEmail,
|
||||
copyright = CR,
|
||||
c_email = CEmail,
|
||||
repo_url = RepoURL,
|
||||
ws_url = WebsiteURL,
|
||||
desc = Desc}) ->
|
||||
{ok, PS} = zx_lib:package_string(ID),
|
||||
TS =
|
||||
case Type of
|
||||
app -> "Erlang application";
|
||||
cli -> "CLI/terminal program";
|
||||
gui -> "GUI application"
|
||||
end,
|
||||
Instructions =
|
||||
"~nAPPLICATION DATA CONFIRMATION~n"
|
||||
"[ 1] Type : ~ts~n"
|
||||
"[ 2] Project Name : ~ts~n"
|
||||
"[ 3] Package ID : ~ts~n"
|
||||
"[ 4] Author : ~ts~n"
|
||||
"[ 5] Author's Email : ~ts~n"
|
||||
"[ 6] Copyright Holder : ~ts~n"
|
||||
"[ 7] Copyright Holder's Email: ~ts~n"
|
||||
"[ 8] License : ~ts~n"
|
||||
"[ 9] Prefix : ~ts~n"
|
||||
"[10] AppMod : ~tw~n"
|
||||
"[11] Repo URL : ~ts~n"
|
||||
"[12] Website URL : ~ts~n"
|
||||
"[13] Description : ~ts~n"
|
||||
"Press a number to select something to change, or [ENTER] to continue.~n",
|
||||
ok = io:format(Instructions,
|
||||
[TS, Name, PS,
|
||||
Author, AEmail,
|
||||
CR, CEmail,
|
||||
License, Prefix, AppMod,
|
||||
RepoURL, WebsiteURL, Desc]),
|
||||
case zx_tty:get_input() of
|
||||
"1" -> initialize(P#project{type = none});
|
||||
"2" -> initialize(P#project{name = none});
|
||||
"3" -> initialize(P#project{id = none});
|
||||
"4" -> initialize(P#project{author = none});
|
||||
"5" -> initialize(P#project{a_email = none});
|
||||
"6" -> initialize(P#project{copyright = none});
|
||||
"7" -> initialize(P#project{c_email = none});
|
||||
"8" -> initialize(P#project{license = none});
|
||||
"9" -> initialize(P#project{prefix = none});
|
||||
"10" -> initialize(P#project{appmod = none});
|
||||
"11" -> initialize(P#project{repo_url = none});
|
||||
"12" -> initialize(P#project{ws_url = none});
|
||||
"13" -> initialize(P#project{desc = none});
|
||||
"" -> initialize_check(P);
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
initialize(P)
|
||||
end.
|
||||
@ -160,16 +261,46 @@ initialize_check(P = #project{id = PackageID}) ->
|
||||
end.
|
||||
|
||||
|
||||
zompify(#project{type = Type, id = ID, prefix = Prefix, appmod = AM, deps = Deps}) ->
|
||||
ok = initialize_app_file(ID, AM),
|
||||
Data =
|
||||
#{package_id => ID,
|
||||
zompify(P = #project{type = Type,
|
||||
name = Name,
|
||||
id = ID,
|
||||
desc = Desc,
|
||||
prefix = Prefix,
|
||||
license = License,
|
||||
author = Author,
|
||||
a_email = AEmail,
|
||||
copyright = CR,
|
||||
c_email = CEmail,
|
||||
repo_url = RepoURL,
|
||||
ws_url = WebsiteURL,
|
||||
appmod = AM,
|
||||
module = Module,
|
||||
deps = Deps}) ->
|
||||
ok = initialize_app_file(ID, AM, Type, Desc),
|
||||
Simple =
|
||||
#{type => Type,
|
||||
package_id => ID,
|
||||
name => Name,
|
||||
desc => Desc,
|
||||
license => License,
|
||||
author => Author,
|
||||
a_email => AEmail,
|
||||
copyright => CR,
|
||||
c_email => CEmail,
|
||||
repo_url => RepoURL,
|
||||
ws_url => WebsiteURL,
|
||||
deps => Deps,
|
||||
type => Type,
|
||||
prefix => Prefix,
|
||||
tags => []},
|
||||
Data =
|
||||
case Type == cli of
|
||||
true -> maps:put(mod, Module, Simple);
|
||||
false -> Simple
|
||||
end,
|
||||
ok = zx_lib:write_project_meta(Data),
|
||||
ok = ensure_emakefile(),
|
||||
ok = ensure_license(P),
|
||||
ok = ensure_gitignore(),
|
||||
{ok, PackageString} = zx_lib:package_string(ID),
|
||||
ok = tell("Project ~ts initialized.", [PackageString]),
|
||||
Message =
|
||||
@ -193,6 +324,52 @@ ensure_emakefile() ->
|
||||
end.
|
||||
|
||||
|
||||
-spec ensure_license(#project{}) -> ok.
|
||||
|
||||
ensure_license(#project{license = skip}) ->
|
||||
ok;
|
||||
ensure_license(#project{name = Name,
|
||||
license = License,
|
||||
copyright = Holder,
|
||||
c_email = CEmail}) ->
|
||||
File =
|
||||
case License of
|
||||
"Apache-2.0" -> "apache2.txt";
|
||||
"BSD-3-Clause-Attribution" -> "bsd3.txt";
|
||||
"BSD-2-Clause-FreeBSD" -> "bsd2.txt";
|
||||
"GPL-3.0-only" -> "gpl3.txt";
|
||||
"GPL-3.0-or-later" -> "gpl3.txt";
|
||||
"LGPL-3.0-only" -> "lgpl3.txt";
|
||||
"LGPL-3.0-or-later" -> "lgpl3.txt";
|
||||
"MIT" -> "mit.txt";
|
||||
"MPL-2.0" -> "mpl2.txt";
|
||||
"CC0" -> "cc0.txt"
|
||||
end,
|
||||
{{Year, _, _}, _} = calendar:local_time(),
|
||||
Substitutions =
|
||||
[{"〘\*PROJECT NAME\*〙", Name},
|
||||
{"〘\*YEAR\*〙", integer_to_list(Year)},
|
||||
{"〘\*COPYRIGHT HOLDER\*〙", copyright_holder(Holder, CEmail)}],
|
||||
Path = filename:join([os:getenv("ZX_DIR"), "templates", "licenses", File]),
|
||||
{ok, Raw} = file:read_file(Path),
|
||||
UTF8 = unicode:characters_to_list(Raw, utf8),
|
||||
Cooked = substitute(UTF8, Substitutions),
|
||||
file:write_file("LICENSE", Cooked).
|
||||
|
||||
|
||||
-spec ensure_gitignore() -> ok.
|
||||
|
||||
ensure_gitignore() ->
|
||||
case filelib:is_regular(".gitignore") of
|
||||
true ->
|
||||
ok;
|
||||
false ->
|
||||
Path = filename:join([os:getenv("ZX_DIR"), "templates", "gitignore"]),
|
||||
{ok, _} = file:copy(Path, ".gitignore"),
|
||||
ok
|
||||
end.
|
||||
|
||||
|
||||
-spec update_source_vsn(zx:version()) -> ok.
|
||||
%% @private
|
||||
%% Use grep to tell us which files have a `-vsn' attribute and which don't.
|
||||
@ -224,14 +401,16 @@ update_app_vsn(Name, Version) ->
|
||||
zx_lib:write_terms(AppFile, [{application, AppName, NewAppData}]).
|
||||
|
||||
|
||||
-spec initialize_app_file(PackageID, AppMod) -> ok
|
||||
-spec initialize_app_file(PackageID, AppMod, Type, Desc) -> ok
|
||||
when PackageID :: zx:package_id(),
|
||||
AppMod :: module().
|
||||
AppMod :: module(),
|
||||
Type :: app | cli | lib | gui,
|
||||
Desc :: string().
|
||||
%% @private
|
||||
%% Update the app file or create it if it is missing.
|
||||
%% TODO: If the app file is missing and an app/*.src exists, interpret that.
|
||||
|
||||
initialize_app_file({_, Name, Version}, AppMod) ->
|
||||
initialize_app_file({_, Name, Version}, AppMod, Type, Desc) ->
|
||||
{ok, VersionString} = zx_lib:version_to_string(Version),
|
||||
AppName = list_to_atom(Name),
|
||||
AppFile = filename:join("ebin", Name ++ ".app"),
|
||||
@ -243,14 +422,16 @@ initialize_app_file({_, Name, Version}, AppMod) ->
|
||||
false ->
|
||||
{application,
|
||||
AppName,
|
||||
[{registered, []},
|
||||
[{description, Desc},
|
||||
{registered, []},
|
||||
{included_applications, []},
|
||||
{applications, [stdlib, kernel]}]}
|
||||
end,
|
||||
Grep = "grep -oP '^-module\\(\\K[^)]+' src/* | cut -d: -f2",
|
||||
Modules = [list_to_atom(M) || M <- string:lexemes(os:cmd(Grep), "\n")],
|
||||
tell("AppMod: ~p", [AppMod]),
|
||||
Properties =
|
||||
case (AppMod == none) or lists:keymember(mod, 1, RawAppData) of
|
||||
case (Type == cli) or (Type == lib) of
|
||||
true ->
|
||||
[{vsn, VersionString},
|
||||
{modules, Modules}];
|
||||
@ -746,18 +927,20 @@ create(P = #project{name = none}) ->
|
||||
create(P#project{name = ask_project_name()});
|
||||
create(P = #project{type = escript, id = none}) ->
|
||||
create(P#project{id = ask_script_name()});
|
||||
create(P = #project{type = app, id = none}) ->
|
||||
ID = {_, AppMod, _} = ask_package_id(),
|
||||
create(P#project{id = ID, appmod = list_to_atom(AppMod)});
|
||||
create(P = #project{type = lib, id = none}) ->
|
||||
ID = {_, Module, _} = ask_package_id(),
|
||||
create(P#project{id = ID, module = list_to_atom(Module)});
|
||||
create(P = #project{type = app, prefix = none}) ->
|
||||
create(P#project{prefix = ask_prefix()});
|
||||
create(P = #project{type = lib, prefix = none}) ->
|
||||
create(P = #project{id = none}) ->
|
||||
ID = {_, AppMod, _} = ask_package_id(),
|
||||
create(P#project{id = ID, appmod = list_to_atom(AppMod)});
|
||||
create(P = #project{prefix = none}) ->
|
||||
create(P#project{prefix = ask_prefix()});
|
||||
create(P = #project{type = app, appmod = none}) ->
|
||||
create(P#project{appmod = ask_appmod()});
|
||||
create(P = #project{type = gui, appmod = none}) ->
|
||||
create(P#project{appmod = ask_appmod()});
|
||||
create(P = #project{type = cli, module = none}) ->
|
||||
create(P#project{module = ask_module()});
|
||||
create(P = #project{type = lib, module = none}) ->
|
||||
create(P#project{module = ask_module()});
|
||||
create(P = #project{author = none, copyright = none}) ->
|
||||
@ -775,48 +958,12 @@ create(P = #project{c_email = none}) ->
|
||||
create(P#project{c_email = ask_email_optional()});
|
||||
create(P = #project{license = none}) ->
|
||||
create(P#project{license = ask_license()});
|
||||
create(P = #project{type = app,
|
||||
license = License,
|
||||
name = Name,
|
||||
id = ID,
|
||||
prefix = Prefix,
|
||||
appmod = AppMod,
|
||||
author = Author,
|
||||
a_email = AEmail,
|
||||
copyright = CR,
|
||||
c_email = CEmail}) ->
|
||||
{ok, PS} = zx_lib:package_string(ID),
|
||||
Instructions =
|
||||
"~nAPPLICATION DATA CONFIRMATION~n"
|
||||
"[ 1] Type : application~n"
|
||||
"[ 2] Project Name : ~ts~n"
|
||||
"[ 3] Package ID : ~ts~n"
|
||||
"[ 4] Author : ~ts~n"
|
||||
"[ 5] Author's Email : ~ts~n"
|
||||
"[ 6] Copyright Holder : ~ts~n"
|
||||
"[ 7] Copyright Holder's Email: ~ts~n"
|
||||
"[ 8] License : ~ts~n"
|
||||
"[ 9] Prefix : ~ts~n"
|
||||
"[10] AppMod : ~tw~n"
|
||||
"Press a number to select something to change, or [ENTER] to continue.~n",
|
||||
ok = io:format(Instructions,
|
||||
[Name, PS, Author, AEmail, CR, CEmail, License, Prefix, AppMod]),
|
||||
case zx_tty:get_input() of
|
||||
"1" -> create(P#project{type = none});
|
||||
"2" -> create(P#project{name = none});
|
||||
"3" -> create(P#project{id = none});
|
||||
"4" -> create(P#project{author = none});
|
||||
"5" -> create(P#project{a_email = none});
|
||||
"6" -> create(P#project{copyright = none});
|
||||
"7" -> create(P#project{c_email = none});
|
||||
"8" -> create(P#project{license = none});
|
||||
"9" -> create(P#project{prefix = none});
|
||||
"10" -> create(P#project{appmod = none});
|
||||
"" -> create_check(P);
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
create(P)
|
||||
end;
|
||||
create(P = #project{desc = none}) ->
|
||||
create(P#project{desc = ask_description()});
|
||||
create(P = #project{repo_url = none}) ->
|
||||
create(P#project{repo_url = ask_url(repo)});
|
||||
create(P = #project{ws_url = none}) ->
|
||||
create(P#project{ws_url = ask_url(website)});
|
||||
create(P = #project{type = lib,
|
||||
license = License,
|
||||
name = Name,
|
||||
@ -826,7 +973,10 @@ create(P = #project{type = lib,
|
||||
author = Author,
|
||||
a_email = AEmail,
|
||||
copyright = CR,
|
||||
c_email = CEmail}) ->
|
||||
c_email = CEmail,
|
||||
repo_url = RepoURL,
|
||||
ws_url = WebsiteURL,
|
||||
desc = Desc}) ->
|
||||
{ok, PS} = zx_lib:package_string(ID),
|
||||
Instructions =
|
||||
"~nLIBRARY DATA CONFIRMATION~n"
|
||||
@ -840,9 +990,16 @@ create(P = #project{type = lib,
|
||||
"[ 8] License : ~ts~n"
|
||||
"[ 9] Prefix : ~ts~n"
|
||||
"[10] Module : ~tw~n"
|
||||
"[11] Repo URL : ~ts~n"
|
||||
"[12] Website URL : ~ts~n"
|
||||
"[13] Description : ~ts~n"
|
||||
"Press a number to select something to change, or [ENTER] to continue.~n",
|
||||
ok = io:format(Instructions,
|
||||
[Name, PS, Author, AEmail, CR, CEmail, License, Prefix, Module]),
|
||||
[Name, PS,
|
||||
Author, AEmail,
|
||||
CR, CEmail,
|
||||
License, Prefix, Module,
|
||||
RepoURL, WebsiteURL, Desc]),
|
||||
case zx_tty:get_input() of
|
||||
"1" -> create(P#project{type = none});
|
||||
"2" -> create(P#project{name = none});
|
||||
@ -854,8 +1011,66 @@ create(P = #project{type = lib,
|
||||
"8" -> create(P#project{license = none});
|
||||
"9" -> create(P#project{prefix = none});
|
||||
"10" -> create(P#project{module = none});
|
||||
"" -> create_check(P);
|
||||
_ ->
|
||||
"11" -> create(P#project{repo_url = none});
|
||||
"12" -> create(P#project{ws_url = none});
|
||||
"13" -> create(P#project{desc = none});
|
||||
"" -> create_check(P);
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
create(P)
|
||||
end;
|
||||
create(P = #project{type = cli,
|
||||
license = License,
|
||||
name = Name,
|
||||
id = ID,
|
||||
prefix = Prefix,
|
||||
module = Module,
|
||||
author = Author,
|
||||
a_email = AEmail,
|
||||
copyright = CR,
|
||||
c_email = CEmail,
|
||||
repo_url = RepoURL,
|
||||
ws_url = WebsiteURL,
|
||||
desc = Desc}) ->
|
||||
{ok, PS} = zx_lib:package_string(ID),
|
||||
Instructions =
|
||||
"~nCLI PROGRAM DATA CONFIRMATION~n"
|
||||
"[ 1] Type : CLI/terminal program~n"
|
||||
"[ 2] Project Name : ~ts~n"
|
||||
"[ 3] Package ID : ~ts~n"
|
||||
"[ 4] Author : ~ts~n"
|
||||
"[ 5] Author's Email : ~ts~n"
|
||||
"[ 6] Copyright Holder : ~ts~n"
|
||||
"[ 7] Copyright Holder's Email: ~ts~n"
|
||||
"[ 8] License : ~ts~n"
|
||||
"[ 9] Prefix : ~ts~n"
|
||||
"[10] Module : ~tw~n"
|
||||
"[11] Repo URL : ~ts~n"
|
||||
"[12] Website URL : ~ts~n"
|
||||
"[13] Description : ~ts~n"
|
||||
"Press a number to select something to change, or [ENTER] to continue.~n",
|
||||
ok = io:format(Instructions,
|
||||
[Name, PS,
|
||||
Author, AEmail,
|
||||
CR, CEmail,
|
||||
License, Prefix, Module,
|
||||
RepoURL, WebsiteURL, Desc]),
|
||||
case zx_tty:get_input() of
|
||||
"1" -> create(P#project{type = none});
|
||||
"2" -> create(P#project{name = none});
|
||||
"3" -> create(P#project{id = none});
|
||||
"4" -> create(P#project{author = none});
|
||||
"5" -> create(P#project{a_email = none});
|
||||
"6" -> create(P#project{copyright = none});
|
||||
"7" -> create(P#project{c_email = none});
|
||||
"8" -> create(P#project{license = none});
|
||||
"9" -> create(P#project{prefix = none});
|
||||
"10" -> create(P#project{module = none});
|
||||
"11" -> create(P#project{repo_url = none});
|
||||
"12" -> create(P#project{ws_url = none});
|
||||
"13" -> create(P#project{desc = none});
|
||||
"" -> create_check(P);
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
create(P)
|
||||
end;
|
||||
@ -892,6 +1107,66 @@ create(P = #project{type = escript,
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
create(P)
|
||||
end;
|
||||
create(P = #project{type = Type,
|
||||
license = License,
|
||||
name = Name,
|
||||
id = ID,
|
||||
prefix = Prefix,
|
||||
appmod = AppMod,
|
||||
author = Author,
|
||||
a_email = AEmail,
|
||||
copyright = CR,
|
||||
c_email = CEmail,
|
||||
repo_url = RepoURL,
|
||||
ws_url = WebsiteURL,
|
||||
desc = Desc}) ->
|
||||
{ok, PS} = zx_lib:package_string(ID),
|
||||
TS =
|
||||
case Type of
|
||||
app -> "Erlang application";
|
||||
gui -> "GUI application"
|
||||
end,
|
||||
Instructions =
|
||||
"~nAPPLICATION DATA CONFIRMATION~n"
|
||||
"[ 1] Type : ~ts~n"
|
||||
"[ 2] Project Name : ~ts~n"
|
||||
"[ 3] Package ID : ~ts~n"
|
||||
"[ 4] Author : ~ts~n"
|
||||
"[ 5] Author's Email : ~ts~n"
|
||||
"[ 6] Copyright Holder : ~ts~n"
|
||||
"[ 7] Copyright Holder's Email: ~ts~n"
|
||||
"[ 8] License : ~ts~n"
|
||||
"[ 9] Prefix : ~ts~n"
|
||||
"[10] AppMod : ~tw~n"
|
||||
"[11] Repo URL : ~ts~n"
|
||||
"[12] Website URL : ~ts~n"
|
||||
"[13] Description : ~ts~n"
|
||||
"Press a number to select something to change, or [ENTER] to continue.~n",
|
||||
ok = io:format(Instructions,
|
||||
[TS, Name, PS,
|
||||
Author, AEmail,
|
||||
CR, CEmail,
|
||||
License, Prefix, AppMod,
|
||||
RepoURL, WebsiteURL, Desc]),
|
||||
case zx_tty:get_input() of
|
||||
"1" -> create(P#project{type = none});
|
||||
"2" -> create(P#project{name = none});
|
||||
"3" -> create(P#project{id = none});
|
||||
"4" -> create(P#project{author = none});
|
||||
"5" -> create(P#project{a_email = none});
|
||||
"6" -> create(P#project{copyright = none});
|
||||
"7" -> create(P#project{c_email = none});
|
||||
"8" -> create(P#project{license = none});
|
||||
"9" -> create(P#project{prefix = none});
|
||||
"10" -> create(P#project{appmod = none});
|
||||
"11" -> create(P#project{repo_url = none});
|
||||
"12" -> create(P#project{ws_url = none});
|
||||
"13" -> create(P#project{desc = none});
|
||||
"" -> create_check(P);
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
create(P)
|
||||
end.
|
||||
|
||||
|
||||
@ -918,8 +1193,8 @@ create_check(P = #project{id = PackageID}) ->
|
||||
{"Check again.", 2},
|
||||
{"Abort and do it later.", 3}],
|
||||
case zx_tty:selet(Options) of
|
||||
1 -> zompify(P);
|
||||
2 -> initialize_check(P);
|
||||
1 -> create_project(P);
|
||||
2 -> create_check(P);
|
||||
3 -> ok
|
||||
end
|
||||
end.
|
||||
@ -952,7 +1227,7 @@ create_project(P = #project{id = {_, Name, _}}) ->
|
||||
case file:make_dir(Name) of
|
||||
ok ->
|
||||
ok = file:set_cwd(Name),
|
||||
munge_sources(P),
|
||||
ok = munge_sources(P),
|
||||
zompify(P);
|
||||
{error, Reason} ->
|
||||
Message = "Creating directory ~ts failed with ~tp. Aborting.",
|
||||
@ -961,37 +1236,6 @@ create_project(P = #project{id = {_, Name, _}}) ->
|
||||
end.
|
||||
|
||||
|
||||
munge_sources(#project{type = app,
|
||||
name = Name,
|
||||
license = Title,
|
||||
prefix = Prefix,
|
||||
appmod = AppMod,
|
||||
author = Credit,
|
||||
a_email = AEmail,
|
||||
copyright = Holder,
|
||||
c_email = CEmail}) ->
|
||||
ok = file:make_dir("src"),
|
||||
ok = file:make_dir("ebin"),
|
||||
{ok, ProjectDir} = file:get_cwd(),
|
||||
Substitutions =
|
||||
[{"〘\*PROJECT NAME\*〙", Name},
|
||||
{"〘\*PREFIX\*〙", Prefix},
|
||||
{"〘\*APP MOD\*〙", atom_to_list(AppMod)},
|
||||
{"〘\*AUTHOR\*〙", author(Credit, AEmail)},
|
||||
{"〘\*COPYRIGHT\*〙", copyright(Holder, CEmail)},
|
||||
{"〘\*LICENSE\*〙", license(Title)}],
|
||||
TemplateDir = filename:join([os:getenv("ZX_DIR"), "templates", "example_server"]),
|
||||
ok = file:set_cwd("src"),
|
||||
AppModFile = atom_to_list(AppMod) ++ ".erl",
|
||||
{ok, RawAppMod} = file:read_file(filename:join(TemplateDir, "appmod.erl")),
|
||||
UTF8AppMod = unicode:characters_to_list(RawAppMod, utf8),
|
||||
CookedAppMod = substitute(UTF8AppMod, Substitutions),
|
||||
ok = file:write_file(AppModFile, CookedAppMod),
|
||||
ModuleTemplates =
|
||||
["sup.erl", "clients.erl", "client_man.erl", "client_sup.erl", "client.erl"],
|
||||
Manifest = [filename:join(TemplateDir, T) || T <- ModuleTemplates],
|
||||
ok = transform(Manifest, Prefix, Substitutions),
|
||||
file:set_cwd(ProjectDir);
|
||||
munge_sources(#project{type = lib,
|
||||
name = Name,
|
||||
license = Title,
|
||||
@ -1016,6 +1260,66 @@ munge_sources(#project{type = lib,
|
||||
UTF8Mod = unicode:characters_to_list(RawMod, utf8),
|
||||
CookedMod = substitute(UTF8Mod, Substitutions),
|
||||
ok = file:write_file(ModFile, CookedMod),
|
||||
file:set_cwd(ProjectDir);
|
||||
munge_sources(#project{type = cli,
|
||||
name = Name,
|
||||
license = Title,
|
||||
module = Module,
|
||||
author = Credit,
|
||||
a_email = AEmail,
|
||||
copyright = Holder,
|
||||
c_email = CEmail}) ->
|
||||
ok = file:make_dir("src"),
|
||||
ok = file:make_dir("ebin"),
|
||||
{ok, ProjectDir} = file:get_cwd(),
|
||||
Substitutions =
|
||||
[{"〘\*PROJECT NAME\*〙", Name},
|
||||
{"〘\*MODULE\*〙", atom_to_list(Module)},
|
||||
{"〘\*AUTHOR\*〙", author(Credit, AEmail)},
|
||||
{"〘\*COPYRIGHT\*〙", copyright(Holder, CEmail)},
|
||||
{"〘\*LICENSE\*〙", license(Title)}],
|
||||
TemplateDir = filename:join([os:getenv("ZX_DIR"), "templates"]),
|
||||
ok = file:set_cwd("src"),
|
||||
ModFile = atom_to_list(Module) ++ ".erl",
|
||||
{ok, RawMod} = file:read_file(filename:join(TemplateDir, "simplecli.erl")),
|
||||
UTF8Mod = unicode:characters_to_list(RawMod, utf8),
|
||||
CookedMod = substitute(UTF8Mod, Substitutions),
|
||||
ok = file:write_file(ModFile, CookedMod),
|
||||
file:set_cwd(ProjectDir);
|
||||
munge_sources(#project{type = Type,
|
||||
name = Name,
|
||||
license = License,
|
||||
prefix = Prefix,
|
||||
appmod = AppMod,
|
||||
author = Credit,
|
||||
a_email = AEmail,
|
||||
copyright = Holder,
|
||||
c_email = CEmail}) ->
|
||||
ok = file:make_dir("src"),
|
||||
ok = file:make_dir("ebin"),
|
||||
{ok, ProjectDir} = file:get_cwd(),
|
||||
Substitutions =
|
||||
[{"〘\*PROJECT NAME\*〙", Name},
|
||||
{"〘\*PREFIX\*〙", Prefix},
|
||||
{"〘\*APP MOD\*〙", atom_to_list(AppMod)},
|
||||
{"〘\*AUTHOR\*〙", author(Credit, AEmail)},
|
||||
{"〘\*COPYRIGHT\*〙", copyright(Holder, CEmail)},
|
||||
{"〘\*LICENSE\*〙", license(License)}],
|
||||
Template =
|
||||
case Type of
|
||||
app -> "example_server";
|
||||
gui -> "hellowx"
|
||||
end,
|
||||
TemplateDir = filename:join([os:getenv("ZX_DIR"), "templates", Template]),
|
||||
ok = file:set_cwd("src"),
|
||||
AppModFile = atom_to_list(AppMod) ++ ".erl",
|
||||
{ok, RawAppMod} = file:read_file(filename:join(TemplateDir, "appmod.erl")),
|
||||
UTF8AppMod = unicode:characters_to_list(RawAppMod, utf8),
|
||||
CookedAppMod = substitute(UTF8AppMod, Substitutions),
|
||||
ok = file:write_file(AppModFile, CookedAppMod),
|
||||
{ok, ModuleTemplates} = file:list_dir(filename:join(TemplateDir, "src")),
|
||||
Manifest = [filename:join([TemplateDir, "src", T]) || T <- ModuleTemplates],
|
||||
ok = transform(Manifest, Prefix, Substitutions),
|
||||
file:set_cwd(ProjectDir).
|
||||
|
||||
|
||||
@ -1051,7 +1355,11 @@ author("", "") -> "";
|
||||
author(Credit, "") -> "-author(\"" ++ Credit ++ "\").";
|
||||
author("", Email) -> "-author(\"<" ++ Email ++ ">\").";
|
||||
author(Credit, Email) -> "-author(\"" ++ Credit ++ " <" ++ Email ++">\").".
|
||||
|
||||
|
||||
copyright_holder("", "") -> "[COPYRIGHT HOLDER]";
|
||||
copyright_holder(Holder, "") -> Holder;
|
||||
copyright_holder("", Email) -> "<" ++ Email ++ ">";
|
||||
copyright_holder(Holder, Email) -> Holder ++ " <" ++ Email ++">".
|
||||
|
||||
|
||||
-spec ask_project_type() -> app | lib | escript | no_return().
|
||||
@ -1065,14 +1373,18 @@ ask_project_type() ->
|
||||
"Remember, an \"application\" in Erlang is anything that needs to be started "
|
||||
"to work, even if it acts in a supporting role.~n"
|
||||
"(Note that escripts cannot be packaged.)~n"
|
||||
"[1] Application~n"
|
||||
"[1] Traditional Erlang service application~n"
|
||||
"[2] Library~n"
|
||||
"[3] Escript~n",
|
||||
"[3] End-user GUI application~n"
|
||||
"[4] End-user CLI application~n"
|
||||
"[5] Escript~n",
|
||||
ok = io:format(Instructions),
|
||||
case zx_tty:get_input() of
|
||||
"1" -> app;
|
||||
"2" -> lib;
|
||||
"3" -> escript;
|
||||
"3" -> gui;
|
||||
"4" -> cli;
|
||||
"5" -> escript;
|
||||
_ ->
|
||||
ok = zx_tty:derp(),
|
||||
ask_project_type()
|
||||
@ -1272,7 +1584,7 @@ create_realm(R = #realm_init{addr = none}) ->
|
||||
create_realm(R = #realm_init{port = none}) ->
|
||||
create_realm(R#realm_init{port = ask_port()});
|
||||
create_realm(R = #realm_init{url = none}) ->
|
||||
create_realm(R#realm_init{url = ask_url()});
|
||||
create_realm(R#realm_init{url = ask_url(realm)});
|
||||
create_realm(R = #realm_init{realm = Realm, sysop = none}) ->
|
||||
create_realm(R#realm_init{sysop = create_sysop(#user_data{realm = Realm})});
|
||||
create_realm(R = #realm_init{realm = Realm, addr = Addr, port = Port, url = URL}) ->
|
||||
@ -1437,9 +1749,12 @@ prompt_port_number(Current) ->
|
||||
end.
|
||||
|
||||
|
||||
-spec ask_url() -> string().
|
||||
-spec ask_url(Type) -> string()
|
||||
when Type :: realm
|
||||
| website
|
||||
| repo.
|
||||
|
||||
ask_url() ->
|
||||
ask_url(realm) ->
|
||||
Message =
|
||||
"~nURL~n"
|
||||
"Most public realms have a website, IRC channel, or similar location where its "
|
||||
@ -1447,6 +1762,25 @@ ask_url() ->
|
||||
"NOTE: No checking is performed on the input here. Confuse your users at "
|
||||
"your own peril!~n"
|
||||
"[ENTER] to leave blank.~n",
|
||||
zx_tty:get_input(Message);
|
||||
ask_url(repo) ->
|
||||
Message =
|
||||
"~nURL~n"
|
||||
"Most projects have a hosted repo URL (gitlab, github, SF, self hosted, etc).~n"
|
||||
"If you have such a URL enter it here.~n"
|
||||
"NOTE: No checking is performed on the input here. Confuse your users at "
|
||||
"your own peril!~n"
|
||||
"[ENTER] to leave blank.~n",
|
||||
zx_tty:get_input(Message);
|
||||
ask_url(website) ->
|
||||
Message =
|
||||
"~nURL~n"
|
||||
"Many project, particularly GUI applications, have a public website where "
|
||||
"documentation, user forums, etc. are hosted.~n"
|
||||
"If you have such a URL enter it here.~n"
|
||||
"NOTE: No checking is performed on the input here. Confuse your users at "
|
||||
"your own peril!~n"
|
||||
"[ENTER] to leave blank.~n",
|
||||
zx_tty:get_input(Message).
|
||||
|
||||
|
||||
@ -1797,7 +2131,7 @@ ask_license() ->
|
||||
{"GNU Library (LGPL) v3.0 or later", "LGPL-3.0-or-later"},
|
||||
{"MIT license", "MIT"},
|
||||
{"Mozilla Public License 2.0", "MPL-2.0"},
|
||||
{"Public Domain", "Public-Domain"},
|
||||
{"Public Domain/Creative Commons Zero notice", "CC0"},
|
||||
{"[proprietary]", proprietary},
|
||||
{"[skip and leave blank]", skip}],
|
||||
case zx_tty:select(Options) of
|
||||
@ -1882,6 +2216,23 @@ email_instructions() ->
|
||||
"Enter an email address.~n".
|
||||
|
||||
|
||||
-spec ask_description() -> string().
|
||||
|
||||
ask_description() ->
|
||||
Instructions =
|
||||
"~nPROJECT DESCRIPTION~n"
|
||||
"Enter a short description of the project.~n"
|
||||
"This description will appear:~n"
|
||||
"- In the project's .app file~n"
|
||||
"- Be displayed when a user uses the `zx describe [project]` command~n"
|
||||
"- (If this is an end-user GUI application) As the program summary in the GUI~n"
|
||||
" program launcher if no HTML summary data is provided on a project site~n"
|
||||
"(NOTE: You can change or update this description in subsequent package "
|
||||
"versions.)~n",
|
||||
String = zx_tty:get_input(Instructions, [], "[ENTER] to leave blank"),
|
||||
unicode:characters_to_list(String, utf8).
|
||||
|
||||
|
||||
-spec realm_exists(zx:realm()) -> boolean().
|
||||
%% @private
|
||||
%% Checks for remnants of a realm.
|
||||
|
||||
203
zomp/lib/otpr/zx/0.2.0/templates/example_server/src/client.erl
Normal file
203
zomp/lib/otpr/zx/0.2.0/templates/example_server/src/client.erl
Normal file
@ -0,0 +1,203 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙 Client
|
||||
%%%
|
||||
%%% An extremely naive (currently Telnet) client handler.
|
||||
%%% Unlike other modules that represent discrete processes, this one does not adhere
|
||||
%%% to any OTP behavior. It does, however, adhere to OTP.
|
||||
%%%
|
||||
%%% In some cases it is more comfortable to write socket handlers or a certain
|
||||
%%% category of state machines as "pure" Erlang processes. This approach is made
|
||||
%%% OTP-able by use of the proc_lib module, which is the underlying library used
|
||||
%%% to write the stdlib's behaviors like gen_server, gen_statem, gen_fsm, etc.
|
||||
%%%
|
||||
%%% http://erlang.org/doc/design_principles/spec_proc.html
|
||||
%%% @end
|
||||
|
||||
-module(〘*PREFIX*〙client).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-export([start/1]).
|
||||
-export([start_link/1, init/2]).
|
||||
-export([system_continue/3, system_terminate/4,
|
||||
system_get_state/1, system_replace_state/2]).
|
||||
|
||||
|
||||
%%% Type and Record Definitions
|
||||
|
||||
|
||||
-record(s, {socket = none :: none | gen_tcp:socket()}).
|
||||
|
||||
|
||||
%% An alias for the state record above. Aliasing state can smooth out annoyances
|
||||
%% that can arise from using the record directly as its own type all over the code.
|
||||
|
||||
-type state() :: #s{}.
|
||||
|
||||
|
||||
%%% Service Interface
|
||||
|
||||
|
||||
-spec start(ListenSocket) -> Result
|
||||
when ListenSocket :: gen_tcp:socket(),
|
||||
Result :: {ok, pid()}
|
||||
| {error, Reason},
|
||||
Reason :: {already_started, pid()}
|
||||
| {shutdown, term()}
|
||||
| term().
|
||||
%% @private
|
||||
%% How the 〘*PREFIX*〙client_man or a prior 〘*PREFIX*〙client kicks things off.
|
||||
%% This is called in the context of 〘*PREFIX*〙client_man or the prior 〘*PREFIX*〙client.
|
||||
|
||||
start(ListenSocket) ->
|
||||
〘*PREFIX*〙client_sup:start_acceptor(ListenSocket).
|
||||
|
||||
|
||||
-spec start_link(ListenSocket) -> Result
|
||||
when ListenSocket :: gen_tcp:socket(),
|
||||
Result :: {ok, pid()}
|
||||
| {error, Reason},
|
||||
Reason :: {already_started, pid()}
|
||||
| {shutdown, term()}
|
||||
| term().
|
||||
%% @private
|
||||
%% This is called by the 〘*PREFIX*〙client_sup. While start/1 is called to iniate a startup
|
||||
%% (essentially requesting a new worker be started by the supervisor), this is
|
||||
%% actually called in the context of the supervisor.
|
||||
|
||||
start_link(ListenSocket) ->
|
||||
proc_lib:start_link(?MODULE, init, [self(), ListenSocket]).
|
||||
|
||||
|
||||
-spec init(Parent, ListenSocket) -> no_return()
|
||||
when Parent :: pid(),
|
||||
ListenSocket :: gen_tcp:socket().
|
||||
%% @private
|
||||
%% This is the first code executed in the context of the new worker itself.
|
||||
%% This function does not have any return value, as the startup return is
|
||||
%% passed back to the supervisor by calling proc_lib:init_ack/2.
|
||||
%% We see the initial form of the typical arity-3 service loop form here in the
|
||||
%% call to listen/3.
|
||||
|
||||
init(Parent, ListenSocket) ->
|
||||
ok = io:format("~p Listening.~n", [self()]),
|
||||
Debug = sys:debug_options([]),
|
||||
ok = proc_lib:init_ack(Parent, {ok, self()}),
|
||||
listen(Parent, Debug, ListenSocket).
|
||||
|
||||
|
||||
-spec listen(Parent, Debug, ListenSocket) -> no_return()
|
||||
when Parent :: pid(),
|
||||
Debug :: [sys:dbg_opt()],
|
||||
ListenSocket :: gen_tcp:socket().
|
||||
%% @private
|
||||
%% This function waits for a TCP connection. The owner of the socket is still
|
||||
%% the 〘*PREFIX*〙client_man (so it can still close it on a call to 〘*PREFIX*〙client_man:ignore/0),
|
||||
%% but the only one calling gen_tcp:accept/1 on it is this process. Closing the socket
|
||||
%% is one way a manager process can gracefully unblock child workers that are blocking
|
||||
%% on a network accept.
|
||||
%%
|
||||
%% Once it makes a TCP connection it will call start/1 to spawn its successor.
|
||||
|
||||
listen(Parent, Debug, ListenSocket) ->
|
||||
case gen_tcp:accept(ListenSocket) of
|
||||
{ok, Socket} ->
|
||||
{ok, _} = start(ListenSocket),
|
||||
{ok, Peer} = inet:peername(Socket),
|
||||
ok = io:format("~p Connection accepted from: ~p~n", [self(), Peer]),
|
||||
ok = 〘*PREFIX*〙client_man:enroll(),
|
||||
State = #s{socket = Socket},
|
||||
loop(Parent, Debug, State);
|
||||
{error, closed} ->
|
||||
ok = io:format("~p Retiring: Listen socket closed.~n", [self()]),
|
||||
exit(normal)
|
||||
end.
|
||||
|
||||
|
||||
-spec loop(Parent, Debug, State) -> no_return()
|
||||
when Parent :: pid(),
|
||||
Debug :: [sys:dbg_opt()],
|
||||
State :: state().
|
||||
%% @private
|
||||
%% The service loop itself. This is the service state. The process blocks on receive
|
||||
%% of Erlang messages, TCP segments being received themselves as Erlang messages.
|
||||
|
||||
loop(Parent, Debug, State = #s{socket = Socket}) ->
|
||||
ok = inet:setopts(Socket, [{active, once}]),
|
||||
receive
|
||||
{tcp, Socket, <<"bye\r\n">>} ->
|
||||
ok = io:format("~p Client saying goodbye. Bye!~n", [self()]),
|
||||
ok = gen_tcp:send(Socket, "Bye!\r\n"),
|
||||
ok = gen_tcp:shutdown(Socket, read_write),
|
||||
exit(normal);
|
||||
{tcp, Socket, Message} ->
|
||||
ok = io:format("~p received: ~tp~n", [self(), Message]),
|
||||
ok = 〘*PREFIX*〙client_man:echo(Message),
|
||||
loop(Parent, Debug, State);
|
||||
{relay, Sender, Message} when Sender == self() ->
|
||||
ok = gen_tcp:send(Socket, ["Message from YOU: ", Message]),
|
||||
loop(Parent, Debug, State);
|
||||
{relay, Sender, Message} ->
|
||||
From = io_lib:format("Message from ~tp: ", [Sender]),
|
||||
ok = gen_tcp:send(Socket, [From, Message]),
|
||||
loop(Parent, Debug, State);
|
||||
{tcp_closed, Socket} ->
|
||||
ok = io:format("~p Socket closed, retiring.~n", [self()]),
|
||||
exit(normal);
|
||||
{system, From, Request} ->
|
||||
sys:handle_system_msg(Request, From, Parent, ?MODULE, Debug, State);
|
||||
Unexpected ->
|
||||
ok = io:format("~p Unexpected message: ~tp", [self(), Unexpected]),
|
||||
loop(Parent, Debug, State)
|
||||
end.
|
||||
|
||||
|
||||
-spec system_continue(Parent, Debug, State) -> no_return()
|
||||
when Parent :: pid(),
|
||||
Debug :: [sys:dbg_opt()],
|
||||
State :: state().
|
||||
%% @private
|
||||
%% The function called by the OTP internal functions after a system message has been
|
||||
%% handled. If the worker process has several possible states this is one place
|
||||
%% resumption of a specific state can be specified and dispatched.
|
||||
|
||||
system_continue(Parent, Debug, State) ->
|
||||
loop(Parent, Debug, State).
|
||||
|
||||
|
||||
-spec system_terminate(Reason, Parent, Debug, State) -> no_return()
|
||||
when Reason :: term(),
|
||||
Parent :: pid(),
|
||||
Debug :: [sys:dbg_opt()],
|
||||
State :: state().
|
||||
%% @private
|
||||
%% Called by the OTP inner bits to allow the process to terminate gracefully.
|
||||
%% Exactly when and if this is callback gets called is specified in the docs:
|
||||
%% See: http://erlang.org/doc/design_principles/spec_proc.html#msg
|
||||
|
||||
system_terminate(Reason, _Parent, _Debug, _State) ->
|
||||
exit(Reason).
|
||||
|
||||
|
||||
|
||||
-spec system_get_state(State) -> {ok, State}
|
||||
when State :: state().
|
||||
%% @private
|
||||
%% This function allows the runtime (or anything else) to inspect the running state
|
||||
%% of the worker process at any arbitrary time.
|
||||
|
||||
system_get_state(State) -> {ok, State}.
|
||||
|
||||
|
||||
-spec system_replace_state(StateFun, State) -> {ok, NewState, State}
|
||||
when StateFun :: fun(),
|
||||
State :: state(),
|
||||
NewState :: term().
|
||||
%% @private
|
||||
%% This function allows the system to update the process state in-place. This is most
|
||||
%% useful for state transitions between code types, like when performing a hot update
|
||||
%% (very cool, but sort of hard) or hot patching a running system (living on the edge!).
|
||||
|
||||
system_replace_state(StateFun, State) ->
|
||||
{ok, StateFun(State), State}.
|
||||
@ -0,0 +1,297 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙 Client Manager
|
||||
%%%
|
||||
%%% This is the "manager" part of the service->worker pattern.
|
||||
%%% It keeps track of who is connected and can act as a router among the workers.
|
||||
%%% Having this process allows us to abstract and customize service-level concepts
|
||||
%%% (the high-level ideas we care about in terms of solving an external problem in the
|
||||
%%% real world) and keep them separate from the lower-level details of supervision that
|
||||
%%% OTP should take care of for us.
|
||||
%%% @end
|
||||
|
||||
-module(〘*PREFIX*〙client_man).
|
||||
-behavior(gen_server).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-export([listen/1, ignore/0]).
|
||||
-export([enroll/0, echo/1]).
|
||||
-export([start_link/0]).
|
||||
-export([init/1, handle_call/3, handle_cast/2, handle_info/2,
|
||||
code_change/3, terminate/2]).
|
||||
|
||||
|
||||
%%% Type and Record Definitions
|
||||
|
||||
|
||||
-record(s, {port_num = none :: none | inet:port_number(),
|
||||
listener = none :: none | gen_tcp:socket(),
|
||||
clients = [] :: [pid()]}).
|
||||
|
||||
|
||||
-type state() :: #s{}.
|
||||
|
||||
|
||||
|
||||
%%% Service Interface
|
||||
|
||||
|
||||
-spec listen(PortNum) -> Result
|
||||
when PortNum :: inet:port_number(),
|
||||
Result :: ok
|
||||
| {error, Reason},
|
||||
Reason :: {listening, inet:port_number()}.
|
||||
%% @doc
|
||||
%% Tell the service to start listening on a given port.
|
||||
%% Only one port can be listened on at a time in the current implementation, so
|
||||
%% an error is returned if the service is already listening.
|
||||
|
||||
listen(PortNum) ->
|
||||
gen_server:call(?MODULE, {listen, PortNum}).
|
||||
|
||||
|
||||
-spec ignore() -> ok.
|
||||
%% @doc
|
||||
%% Tell the service to stop listening.
|
||||
%% It is not an error to call this function when the service is not listening.
|
||||
|
||||
ignore() ->
|
||||
gen_server:cast(?MODULE, ignore).
|
||||
|
||||
|
||||
|
||||
%%% Client Process Interface
|
||||
|
||||
|
||||
-spec enroll() -> ok.
|
||||
%% @doc
|
||||
%% Clients register here when they establish a connection.
|
||||
%% Other processes can enroll as well.
|
||||
|
||||
enroll() ->
|
||||
gen_server:cast(?MODULE, {enroll, self()}).
|
||||
|
||||
|
||||
-spec echo(Message) -> ok
|
||||
when Message :: string().
|
||||
%% @doc
|
||||
%% The function that tells the manager to broadcast a message to all clients.
|
||||
%% This can broadcast arbitrary strings to clients from non-clients as well.
|
||||
|
||||
echo(Message) ->
|
||||
gen_server:cast(?MODULE, {echo, Message, self()}).
|
||||
|
||||
|
||||
|
||||
%%% Startup Functions
|
||||
|
||||
|
||||
-spec start_link() -> Result
|
||||
when Result :: {ok, pid()}
|
||||
| {error, Reason :: term()}.
|
||||
%% @private
|
||||
%% This should only ever be called by 〘*PREFIX*〙clients (the service-level supervisor).
|
||||
|
||||
start_link() ->
|
||||
gen_server:start_link({local, ?MODULE}, ?MODULE, none, []).
|
||||
|
||||
|
||||
-spec init(none) -> {ok, state()}.
|
||||
%% @private
|
||||
%% Called by the supervisor process to give the process a chance to perform any
|
||||
%% preparatory work necessary for proper function.
|
||||
|
||||
init(none) ->
|
||||
ok = io:format("Starting.~n"),
|
||||
State = #s{},
|
||||
{ok, State}.
|
||||
|
||||
|
||||
|
||||
%%% gen_server Message Handling Callbacks
|
||||
|
||||
|
||||
-spec handle_call(Message, From, State) -> Result
|
||||
when Message :: term(),
|
||||
From :: {pid(), reference()},
|
||||
State :: state(),
|
||||
Result :: {reply, Response, NewState}
|
||||
| {noreply, State},
|
||||
Response :: ok
|
||||
| {error, {listening, inet:port_number()}},
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:handle_call/3 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_call-3
|
||||
|
||||
handle_call({listen, PortNum}, _, State) ->
|
||||
{Response, NewState} = do_listen(PortNum, State),
|
||||
{reply, Response, NewState};
|
||||
handle_call(Unexpected, From, State) ->
|
||||
ok = io:format("~p Unexpected call from ~tp: ~tp~n", [self(), From, Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
-spec handle_cast(Message, State) -> {noreply, NewState}
|
||||
when Message :: term(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:handle_cast/2 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_cast-2
|
||||
|
||||
handle_cast({enroll, Pid}, State) ->
|
||||
NewState = do_enroll(Pid, State),
|
||||
{noreply, NewState};
|
||||
handle_cast({echo, Message, Sender}, State) ->
|
||||
ok = do_echo(Message, Sender, State),
|
||||
{noreply, State};
|
||||
handle_cast(ignore, State) ->
|
||||
NewState = do_ignore(State),
|
||||
{noreply, NewState};
|
||||
handle_cast(Unexpected, State) ->
|
||||
ok = io:format("~p Unexpected cast: ~tp~n", [self(), Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
-spec handle_info(Message, State) -> {noreply, NewState}
|
||||
when Message :: term(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:handle_info/2 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_info-2
|
||||
|
||||
handle_info({'DOWN', Mon, process, Pid, Reason}, State) ->
|
||||
NewState = handle_down(Mon, Pid, Reason, State),
|
||||
{noreply, NewState};
|
||||
handle_info(Unexpected, State) ->
|
||||
ok = io:format("~p Unexpected info: ~tp~n", [self(), Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
|
||||
%%% OTP Service Functions
|
||||
|
||||
-spec code_change(OldVersion, State, Extra) -> Result
|
||||
when OldVersion :: {down, Version} | Version,
|
||||
Version :: term(),
|
||||
State :: state(),
|
||||
Extra :: term(),
|
||||
Result :: {ok, NewState}
|
||||
| {error, Reason :: term()},
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:code_change/3 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:code_change-3
|
||||
|
||||
code_change(_, State, _) ->
|
||||
{ok, State}.
|
||||
|
||||
|
||||
-spec terminate(Reason, State) -> no_return()
|
||||
when Reason :: normal
|
||||
| shutdown
|
||||
| {shutdown, term()}
|
||||
| term(),
|
||||
State :: state().
|
||||
%% @private
|
||||
%% The gen_server:terminate/2 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:terminate-2
|
||||
|
||||
terminate(_, _) ->
|
||||
ok.
|
||||
|
||||
|
||||
|
||||
%%% Doer Functions
|
||||
|
||||
-spec do_listen(PortNum, State) -> {Result, NewState}
|
||||
when PortNum :: inet:port_number(),
|
||||
State :: state(),
|
||||
Result :: ok
|
||||
| {error, Reason :: {listening, inet:port_number()}},
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The "doer" procedure called when a "listen" message is received.
|
||||
|
||||
do_listen(PortNum, State = #s{port_num = none}) ->
|
||||
SocketOptions =
|
||||
[inet6,
|
||||
{packet, line},
|
||||
{active, once},
|
||||
{mode, binary},
|
||||
{keepalive, true},
|
||||
{reuseaddr, true}],
|
||||
{ok, Listener} = gen_tcp:listen(PortNum, SocketOptions),
|
||||
{ok, _} = 〘*PREFIX*〙client:start(Listener),
|
||||
{ok, State#s{port_num = PortNum, listener = Listener}};
|
||||
do_listen(_, State = #s{port_num = PortNum}) ->
|
||||
ok = io:format("~p Already listening on ~p~n", [self(), PortNum]),
|
||||
{{error, {listening, PortNum}}, State}.
|
||||
|
||||
|
||||
-spec do_ignore(State) -> NewState
|
||||
when State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The "doer" procedure called when an "ignore" message is received.
|
||||
|
||||
do_ignore(State = #s{listener = none}) ->
|
||||
State;
|
||||
do_ignore(State = #s{listener = Listener}) ->
|
||||
ok = gen_tcp:close(Listener),
|
||||
State#s{listener = none}.
|
||||
|
||||
|
||||
-spec do_enroll(Pid, State) -> NewState
|
||||
when Pid :: pid(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
|
||||
do_enroll(Pid, State = #s{clients = Clients}) ->
|
||||
case lists:member(Pid, Clients) of
|
||||
false ->
|
||||
Mon = monitor(process, Pid),
|
||||
ok = io:format("Monitoring ~tp @ ~tp~n", [Pid, Mon]),
|
||||
State#s{clients = [Pid | Clients]};
|
||||
true ->
|
||||
State
|
||||
end.
|
||||
|
||||
|
||||
-spec do_echo(Message, Sender, State) -> ok
|
||||
when Message :: string(),
|
||||
Sender :: pid(),
|
||||
State :: state().
|
||||
%% @private
|
||||
%% The "doer" procedure called when an "echo" message is received.
|
||||
|
||||
do_echo(Message, Sender, #s{clients = Clients}) ->
|
||||
Send = fun(Client) -> Client ! {relay, Sender, Message} end,
|
||||
lists:foreach(Send, Clients).
|
||||
|
||||
|
||||
-spec handle_down(Mon, Pid, Reason, State) -> NewState
|
||||
when Mon :: reference(),
|
||||
Pid :: pid(),
|
||||
Reason :: term(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% Deal with monitors. When a new process enrolls as a client a monitor is set and
|
||||
%% the process is added to the client list. When the process terminates we receive
|
||||
%% a 'DOWN' message from the monitor. More sophisticated work managers typically have
|
||||
%% an "unenroll" function, but this echo service doesn't need one.
|
||||
|
||||
handle_down(Mon, Pid, Reason, State = #s{clients = Clients}) ->
|
||||
case lists:member(Pid, Clients) of
|
||||
true ->
|
||||
NewClients = lists:delete(Pid, Clients),
|
||||
State#s{clients = NewClients};
|
||||
false ->
|
||||
Unexpected = {'DOWN', Mon, process, Pid, Reason},
|
||||
ok = io:format("~p Unexpected info: ~tp~n", [self(), Unexpected]),
|
||||
State
|
||||
end.
|
||||
@ -0,0 +1,69 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙 Client Supervisor
|
||||
%%%
|
||||
%%% This process supervises the client socket handlers themselves. It is a peer of the
|
||||
%%% 〘*PREFIX*〙client_man (the manager interface to this network service component), and a
|
||||
%%% child of the supervisor named 〘*PREFIX*〙clients.
|
||||
%%%
|
||||
%%% Because we don't know (or care) how many client connections the server may end up
|
||||
%%% handling this is a simple_one_for_one supervisor which can spawn and manage as
|
||||
%%% many identically defined workers as required, but cannot supervise any other types
|
||||
%%% of processes (one of the tradeoffs of the "simple" in `simple_one_for_one').
|
||||
%%%
|
||||
%%% http://erlang.org/doc/design_principles/sup_princ.html#id79244
|
||||
%%% @end
|
||||
|
||||
-module(〘*PREFIX*〙client_sup).
|
||||
-behaviour(supervisor).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
|
||||
-export([start_acceptor/1]).
|
||||
-export([start_link/0]).
|
||||
-export([init/1]).
|
||||
|
||||
|
||||
|
||||
-spec start_acceptor(ListenSocket) -> Result
|
||||
when ListenSocket :: gen_tcp:socket(),
|
||||
Result :: {ok, pid()}
|
||||
| {error, Reason},
|
||||
Reason :: {already_started, pid()}
|
||||
| {shutdown, term()}
|
||||
| term().
|
||||
%% @private
|
||||
%% Spawns the first listener at the request of the 〘*PREFIX*〙client_man when es:listen/1
|
||||
%% is called, or the next listener at the request of the currently listening 〘*PREFIX*〙client
|
||||
%% when a connection is made.
|
||||
%%
|
||||
%% Error conditions, supervision strategies and other important issues are
|
||||
%% explained in the supervisor module docs:
|
||||
%% http://erlang.org/doc/man/supervisor.html
|
||||
|
||||
start_acceptor(ListenSocket) ->
|
||||
supervisor:start_child(?MODULE, [ListenSocket]).
|
||||
|
||||
|
||||
-spec start_link() -> {ok, pid()}.
|
||||
%% @private
|
||||
%% This supervisor's own start function.
|
||||
|
||||
start_link() ->
|
||||
supervisor:start_link({local, ?MODULE}, ?MODULE, none).
|
||||
|
||||
|
||||
-spec init(none) -> {ok, {supervisor:sup_flags(), [supervisor:child_spec()]}}.
|
||||
%% @private
|
||||
%% The OTP init/1 function.
|
||||
|
||||
init(none) ->
|
||||
RestartStrategy = {simple_one_for_one, 1, 60},
|
||||
Client = {〘*PREFIX*〙client,
|
||||
{〘*PREFIX*〙client, start_link, []},
|
||||
temporary,
|
||||
brutal_kill,
|
||||
worker,
|
||||
[〘*PREFIX*〙client]},
|
||||
{ok, {RestartStrategy, [Client]}}.
|
||||
@ -0,0 +1,47 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙 Client Service Supervisor
|
||||
%%%
|
||||
%%% This is the service-level supervisor of the system. It is the parent of both the
|
||||
%%% client connection handlers and the client manager (which manages the client
|
||||
%%% connection handlers). This is the child of 〘*PREFIX*〙sup.
|
||||
%%%
|
||||
%%% See: http://erlang.org/doc/apps/kernel/application.html
|
||||
%%% @end
|
||||
|
||||
-module(〘*PREFIX*〙clients).
|
||||
-behavior(supervisor).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-export([start_link/0]).
|
||||
-export([init/1]).
|
||||
|
||||
|
||||
-spec start_link() -> {ok, pid()}.
|
||||
%% @private
|
||||
%% This supervisor's own start function.
|
||||
|
||||
start_link() ->
|
||||
supervisor:start_link({local, ?MODULE}, ?MODULE, none).
|
||||
|
||||
-spec init(none) -> {ok, {supervisor:sup_flags(), [supervisor:child_spec()]}}.
|
||||
%% @private
|
||||
%% The OTP init/1 function.
|
||||
|
||||
init(none) ->
|
||||
RestartStrategy = {rest_for_one, 1, 60},
|
||||
ClientSup = {〘*PREFIX*〙client_sup,
|
||||
{〘*PREFIX*〙client_sup, start_link, []},
|
||||
permanent,
|
||||
5000,
|
||||
supervisor,
|
||||
[〘*PREFIX*〙client_sup]},
|
||||
ClientMan = {〘*PREFIX*〙client_man,
|
||||
{〘*PREFIX*〙client_man, start_link, []},
|
||||
permanent,
|
||||
5000,
|
||||
worker,
|
||||
[〘*PREFIX*〙client_man]},
|
||||
Children = [ClientSup, ClientMan],
|
||||
{ok, {RestartStrategy, Children}}.
|
||||
45
zomp/lib/otpr/zx/0.2.0/templates/example_server/src/sup.erl
Normal file
45
zomp/lib/otpr/zx/0.2.0/templates/example_server/src/sup.erl
Normal file
@ -0,0 +1,45 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙 Top-level Supervisor
|
||||
%%%
|
||||
%%% The very top level supervisor in the system. It only has one service branch: the
|
||||
%%% client handling service. In a more complex system the client handling service would
|
||||
%%% only be one part of a larger system. Were this a game system, for example, the
|
||||
%%% item data management service would be a peer, as would a login credential provision
|
||||
%%% service, game world event handling, and so on.
|
||||
%%%
|
||||
%%% See: http://erlang.org/doc/design_principles/applications.html
|
||||
%%% See: http://zxq9.com/archives/1311
|
||||
%%% @end
|
||||
|
||||
-module(〘*PREFIX*〙sup).
|
||||
-behaviour(supervisor).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-export([start_link/0]).
|
||||
-export([init/1]).
|
||||
|
||||
|
||||
-spec start_link() -> {ok, pid()}.
|
||||
%% @private
|
||||
%% This supervisor's own start function.
|
||||
|
||||
start_link() ->
|
||||
supervisor:start_link({local, ?MODULE}, ?MODULE, []).
|
||||
|
||||
|
||||
-spec init([]) -> {ok, {supervisor:sup_flags(), [supervisor:child_spec()]}}.
|
||||
%% @private
|
||||
%% The OTP init/1 function.
|
||||
|
||||
init([]) ->
|
||||
RestartStrategy = {one_for_one, 1, 60},
|
||||
Clients = {〘*PREFIX*〙clients,
|
||||
{〘*PREFIX*〙clients, start_link, []},
|
||||
permanent,
|
||||
5000,
|
||||
supervisor,
|
||||
[〘*PREFIX*〙clients]},
|
||||
Children = [Clients],
|
||||
{ok, {RestartStrategy, Children}}.
|
||||
15
zomp/lib/otpr/zx/0.2.0/templates/gitignore
Normal file
15
zomp/lib/otpr/zx/0.2.0/templates/gitignore
Normal file
@ -0,0 +1,15 @@
|
||||
.eunit
|
||||
deps
|
||||
*.o
|
||||
*.beam
|
||||
*.plt
|
||||
*.swp
|
||||
erl_crash.dump
|
||||
ebin/*.beam
|
||||
doc/*.html
|
||||
doc/*.css
|
||||
doc/edoc-info
|
||||
doc/erlang.png
|
||||
rel/example_project
|
||||
.concrete/DEV_MODE
|
||||
.rebar
|
||||
75
zomp/lib/otpr/zx/0.2.0/templates/hellowx/appmod.erl
Normal file
75
zomp/lib/otpr/zx/0.2.0/templates/hellowx/appmod.erl
Normal file
@ -0,0 +1,75 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙
|
||||
%%% @end
|
||||
|
||||
-module(〘*APP MOD*〙).
|
||||
-behavior(application).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-export([listen/1, ignore/0]).
|
||||
-export([start/0, start/1]).
|
||||
-export([start/2, stop/1]).
|
||||
|
||||
|
||||
|
||||
-spec listen(PortNum) -> Result
|
||||
when PortNum :: inet:port_num(),
|
||||
Result :: ok
|
||||
| {error, {listening, inet:port_num()}}.
|
||||
%% @doc
|
||||
%% Make the server start listening on a port.
|
||||
%% Returns an {error, Reason} tuple if it is already listening.
|
||||
|
||||
listen(PortNum) ->
|
||||
〘*PREFIX*〙client_man:listen(PortNum).
|
||||
|
||||
|
||||
-spec ignore() -> ok.
|
||||
%% @doc
|
||||
%% Make the server stop listening if it is, or continue to do nothing if it isn't.
|
||||
|
||||
ignore() ->
|
||||
〘*PREFIX*〙client_man:ignore().
|
||||
|
||||
|
||||
-spec start() -> ok.
|
||||
%% @doc
|
||||
%% Start the server in an "ignore" state.
|
||||
|
||||
start() ->
|
||||
ok = application:ensure_started(sasl),
|
||||
ok = application:start(example_server),
|
||||
io:format("Starting es...").
|
||||
|
||||
|
||||
-spec start(PortNum) -> ok
|
||||
when PortNum :: inet:port_number().
|
||||
%% @doc
|
||||
%% Start the server and begin listening immediately. Slightly more convenient when
|
||||
%% playing around in the shell.
|
||||
|
||||
start(PortNum) ->
|
||||
ok = start(),
|
||||
ok = 〘*PREFIX*〙client_man:listen(PortNum),
|
||||
io:format("Startup complete, listening on ~w~n", [PortNum]).
|
||||
|
||||
|
||||
-spec start(normal, term()) -> {ok, pid()}.
|
||||
%% @private
|
||||
%% Called by OTP to kick things off. This is for the use of the "application" part of
|
||||
%% OTP, not to be called by user code.
|
||||
%% See: http://erlang.org/doc/apps/kernel/application.html
|
||||
|
||||
start(normal, _Args) ->
|
||||
〘*PREFIX*〙sup:start_link().
|
||||
|
||||
|
||||
-spec stop(term()) -> ok.
|
||||
%% @private
|
||||
%% Similar to start/2 above, this is to be called by the "application" part of OTP,
|
||||
%% not client code. Causes a (hopefully graceful) shutdown of the application.
|
||||
|
||||
stop(_State) ->
|
||||
ok.
|
||||
129
zomp/lib/otpr/zx/0.2.0/templates/hellowx/src/con.erl
Normal file
129
zomp/lib/otpr/zx/0.2.0/templates/hellowx/src/con.erl
Normal file
@ -0,0 +1,129 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙 Controller
|
||||
%%%
|
||||
%%% This process is a in charge of maintaining the program's state.
|
||||
%%% @end
|
||||
|
||||
-module(〘*PREFIX*〙con).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-behavior(gen_server).
|
||||
-export([start_link/0, stop/0]).
|
||||
-export([init/1, terminate/2, code_change/3,
|
||||
handle_call/3, handle_cast/2, handle_info/2]).
|
||||
-include("$zx_include/zx_logger.hrl").
|
||||
|
||||
|
||||
%%% Type and Record Definitions
|
||||
|
||||
|
||||
-record(s,
|
||||
{window = none :: none | wx:wx_object()}).
|
||||
|
||||
-type state() :: #s{}.
|
||||
|
||||
|
||||
|
||||
%% Interface
|
||||
|
||||
-spec stop() -> ok.
|
||||
|
||||
stop() ->
|
||||
gen_server:cast(?MODULE, stop).
|
||||
|
||||
|
||||
|
||||
%%% Startup Functions
|
||||
|
||||
|
||||
-spec start_link() -> Result
|
||||
when Result :: {ok, pid()}
|
||||
| {error, Reason},
|
||||
Reason :: {already_started, pid()}
|
||||
| {shutdown, term()}
|
||||
| term().
|
||||
%% @private
|
||||
%% Called by 〘*PREFIX*〙sup.
|
||||
|
||||
start_link() ->
|
||||
gen_server:start_link({local, ?MODULE}, ?MODULE, none, []).
|
||||
|
||||
|
||||
-spec init(none) -> no_return().
|
||||
|
||||
init(none) ->
|
||||
ok = log(info, "Starting"),
|
||||
Window = 〘*PREFIX*〙gui:start_link("Hello, WX!"),
|
||||
ok = log(info, "Window: ~p", [Window]),
|
||||
State = #s{window = Window},
|
||||
String = "This is a text string.",
|
||||
ok = 〘*PREFIX*〙gui:show(String),
|
||||
{ok, State}.
|
||||
|
||||
|
||||
|
||||
%%% gen_server Message Handling Callbacks
|
||||
|
||||
|
||||
-spec handle_call(Message, From, State) -> Result
|
||||
when Message :: term(),
|
||||
From :: {pid(), reference()},
|
||||
State :: state(),
|
||||
Result :: {reply, Response, NewState}
|
||||
| {noreply, State},
|
||||
Response :: ok
|
||||
| {error, {listening, inet:port_number()}},
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:handle_call/3 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_call-3
|
||||
|
||||
handle_call(Unexpected, From, State) ->
|
||||
ok = log(warning, "Unexpected call from ~tp: ~tp~n", [From, Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
-spec handle_cast(Message, State) -> {noreply, NewState}
|
||||
when Message :: term(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:handle_cast/2 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_cast-2
|
||||
|
||||
handle_cast(stop, State) ->
|
||||
ok = log(info, "Received a 'stop' message."),
|
||||
% {noreply, State};
|
||||
{stop, normal, State};
|
||||
handle_cast(Unexpected, State) ->
|
||||
ok = log(warning, "Unexpected cast: ~tp~n", [Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
-spec handle_info(Message, State) -> {noreply, NewState}
|
||||
when Message :: term(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:handle_info/2 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_info-2
|
||||
|
||||
handle_info(Unexpected, State) ->
|
||||
ok = log(warning, "Unexpected info: ~tp~n", [Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
|
||||
%% @private
|
||||
%% gen_server callback to handle state transformations necessary for hot
|
||||
%% code updates. This template performs no transformation.
|
||||
|
||||
code_change(_, State, _) ->
|
||||
{ok, State}.
|
||||
|
||||
|
||||
terminate(Reason, State) ->
|
||||
ok = log(info, "Reason: ~tp, State: ~tp", [Reason, State]),
|
||||
zx:stop().
|
||||
140
zomp/lib/otpr/zx/0.2.0/templates/hellowx/src/gui.erl
Normal file
140
zomp/lib/otpr/zx/0.2.0/templates/hellowx/src/gui.erl
Normal file
@ -0,0 +1,140 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙 GUI
|
||||
%%%
|
||||
%%% This process is responsible for creating the main GUI frame displayed to the user.
|
||||
%%%
|
||||
%%% Reference: http://erlang.org/doc/man/wx_object.html
|
||||
%%% @end
|
||||
|
||||
-module(〘*PREFIX*〙gui).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-behavior(wx_object).
|
||||
-include_lib("wx/include/wx.hrl").
|
||||
-export([show/1]).
|
||||
-export([start_link/1]).
|
||||
-export([init/1, terminate/2, code_change/3,
|
||||
handle_call/3, handle_cast/2, handle_info/2, handle_event/2]).
|
||||
-include("$zx_include/zx_logger.hrl").
|
||||
|
||||
|
||||
-record(s,
|
||||
{frame = none :: none | wx:wx_object(),
|
||||
text = none :: none | wx:wx_object()}).
|
||||
|
||||
|
||||
-type state() :: term().
|
||||
|
||||
|
||||
%%% Element Labels
|
||||
|
||||
-define(sysMENU, 10).
|
||||
-define(sysLANG, 11).
|
||||
-define(sysQUERY, 12).
|
||||
|
||||
|
||||
|
||||
show(String) ->
|
||||
wx_object:cast(?MODULE, {show, String}).
|
||||
|
||||
|
||||
|
||||
%%% Startup Functions
|
||||
|
||||
start_link(Title) ->
|
||||
wx_object:start_link({local, ?MODULE}, ?MODULE, Title, []).
|
||||
|
||||
|
||||
init(Title) ->
|
||||
ok = log(info, "GUI starting..."),
|
||||
Wx = wx:new(),
|
||||
Frame = wxFrame:new(Wx, ?wxID_ANY, Title),
|
||||
MainSz = wxBoxSizer:new(?wxVERTICAL),
|
||||
TextC = wxTextCtrl:new(Frame, ?wxID_ANY, [{style, ?wxDEFAULT bor ?wxTE_MULTILINE}]),
|
||||
wxSizer:add(MainSz, TextC, [{flag, ?wxEXPAND}, {proportion, 1}]),
|
||||
wxFrame:setSizer(Frame, MainSz),
|
||||
wxSizer:layout(MainSz),
|
||||
|
||||
ok = wxFrame:connect(Frame, close_window),
|
||||
ok = wxFrame:center(Frame),
|
||||
true = wxFrame:show(Frame),
|
||||
State = #s{frame = Frame, text = TextC},
|
||||
{Frame, State}.
|
||||
|
||||
|
||||
-spec handle_call(Message, From, State) -> Result
|
||||
when Message :: term(),
|
||||
From :: {pid(), reference()},
|
||||
State :: state(),
|
||||
Result :: {reply, Response, NewState}
|
||||
| {noreply, State},
|
||||
Response :: ok
|
||||
| {error, {listening, inet:port_number()}},
|
||||
NewState :: state().
|
||||
|
||||
handle_call(Unexpected, From, State) ->
|
||||
ok = log(warning, "Unexpected call from ~tp: ~tp~n", [From, Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
-spec handle_cast(Message, State) -> {noreply, NewState}
|
||||
when Message :: term(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:handle_cast/2 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_cast-2
|
||||
|
||||
handle_cast({show, String}, State) ->
|
||||
ok = do_show(String, State),
|
||||
{noreply, State};
|
||||
handle_cast(Unexpected, State) ->
|
||||
ok = log(warning, "Unexpected cast: ~tp~n", [Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
-spec handle_info(Message, State) -> {noreply, NewState}
|
||||
when Message :: term(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The gen_server:handle_info/2 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_info-2
|
||||
|
||||
handle_info(Unexpected, State) ->
|
||||
ok = log(warning, "Unexpected info: ~tp~n", [Unexpected]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
-spec handle_event(Event, State) -> {noreply, NewState}
|
||||
when Event :: term(),
|
||||
State :: state(),
|
||||
NewState :: state().
|
||||
%% @private
|
||||
%% The wx_object:handle_event/2 callback.
|
||||
%% See: http://erlang.org/doc/man/gen_server.html#Module:handle_info-2
|
||||
|
||||
handle_event(#wx{event = #wxClose{}}, State = #s{frame = Frame}) ->
|
||||
ok = 〘*PREFIX*〙con:stop(),
|
||||
ok = wxWindow:destroy(Frame),
|
||||
{noreply, State};
|
||||
handle_event(Event, State) ->
|
||||
ok = log(info, "Unexpected event ~tp State: ~tp~n", [Event, State]),
|
||||
{noreply, State}.
|
||||
|
||||
|
||||
|
||||
code_change(_, State, _) ->
|
||||
{ok, State}.
|
||||
|
||||
|
||||
terminate(Reason, State) ->
|
||||
ok = log(info, "Reason: ~tp, State: ~tp", [Reason, State]),
|
||||
wx:destroy().
|
||||
|
||||
|
||||
|
||||
do_show(String, #s{text = TextC}) ->
|
||||
wxTextCtrl:changeValue(TextC, String).
|
||||
45
zomp/lib/otpr/zx/0.2.0/templates/hellowx/src/sup.erl
Normal file
45
zomp/lib/otpr/zx/0.2.0/templates/hellowx/src/sup.erl
Normal file
@ -0,0 +1,45 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙 Top-level Supervisor
|
||||
%%%
|
||||
%%% The very top level supervisor in the system. It only has one service branch: the
|
||||
%%% "con" (program controller). The con is the
|
||||
%%% only be one part of a larger system. Were this a game system, for example, the
|
||||
%%% item data management service would be a peer, as would a login credential provision
|
||||
%%% service, game world event handling, and so on.
|
||||
%%%
|
||||
%%% See: http://erlang.org/doc/design_principles/applications.html
|
||||
%%% See: http://zxq9.com/archives/1311
|
||||
%%% @end
|
||||
|
||||
-module(〘*PREFIX*〙sup).
|
||||
-behaviour(supervisor).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-export([start_link/0]).
|
||||
-export([init/1]).
|
||||
|
||||
|
||||
-spec start_link() -> {ok, pid()}.
|
||||
%% @private
|
||||
%% This supervisor's own start function.
|
||||
|
||||
start_link() ->
|
||||
supervisor:start_link({local, ?MODULE}, ?MODULE, []).
|
||||
|
||||
|
||||
-spec init([]) -> {ok, {supervisor:sup_flags(), [supervisor:child_spec()]}}.
|
||||
%% @private
|
||||
%% The OTP init/1 function.
|
||||
|
||||
init([]) ->
|
||||
RestartStrategy = {one_for_one, 0, 60},
|
||||
Clients = {〘*PREFIX*〙con,
|
||||
{〘*PREFIX*〙con, start_link, []},
|
||||
permanent,
|
||||
5000,
|
||||
supervisor,
|
||||
[〘*PREFIX*〙con]},
|
||||
Children = [Clients],
|
||||
{ok, {RestartStrategy, Children}}.
|
||||
203
zomp/lib/otpr/zx/0.2.0/templates/licenses/apache2.txt
Normal file
203
zomp/lib/otpr/zx/0.2.0/templates/licenses/apache2.txt
Normal file
@ -0,0 +1,203 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 〘*YEAR*〙 〘*COPYRIGHT HOLDER*〙
|
||||
|
||||
|
||||
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.
|
||||
26
zomp/lib/otpr/zx/0.2.0/templates/licenses/bsd2.txt
Normal file
26
zomp/lib/otpr/zx/0.2.0/templates/licenses/bsd2.txt
Normal file
@ -0,0 +1,26 @@
|
||||
Copyright 〘*YEAR*〙 〘*COPYRIGHT HOLDER*〙
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions
|
||||
are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||||
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||||
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
||||
30
zomp/lib/otpr/zx/0.2.0/templates/licenses/bsd3.txt
Normal file
30
zomp/lib/otpr/zx/0.2.0/templates/licenses/bsd3.txt
Normal file
@ -0,0 +1,30 @@
|
||||
Copyright 〘*YEAR*〙 〘*COPYRIGHT HOLDER*〙
|
||||
|
||||
Redistribution and use in source and binary forms, with or without
|
||||
modification, are permitted provided that the following conditions
|
||||
are met:
|
||||
|
||||
1. Redistributions of source code must retain the above copyright
|
||||
notice, this list of conditions and the following disclaimer.
|
||||
|
||||
2. Redistributions in binary form must reproduce the above copyright
|
||||
notice, this list of conditions and the following disclaimer in
|
||||
the documentation and/or other materials provided with the
|
||||
distribution.
|
||||
|
||||
3. Neither the name of the copyright holder nor the names of its
|
||||
contributors may be used to endorse or promote products derived
|
||||
from this software without specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||||
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||||
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGE.
|
||||
4
zomp/lib/otpr/zx/0.2.0/templates/licenses/cc0.txt
Normal file
4
zomp/lib/otpr/zx/0.2.0/templates/licenses/cc0.txt
Normal file
@ -0,0 +1,4 @@
|
||||
To the extent possible under law, 〘\*COPYRIGHT HOLDER\*〙 has waived all copyright and related or neighboring rights to 〘\*PROJECT NAME\*〙.
|
||||
|
||||
A more complete reference for the reasoning and formulation of this waiver of property rights is available at the Creative Commons Zero ("CC0") page:
|
||||
https://creativecommons.org/share-your-work/public-domain/cc0/
|
||||
674
zomp/lib/otpr/zx/0.2.0/templates/licenses/gpl3.txt
Normal file
674
zomp/lib/otpr/zx/0.2.0/templates/licenses/gpl3.txt
Normal file
@ -0,0 +1,674 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
165
zomp/lib/otpr/zx/0.2.0/templates/licenses/lgpl3.txt
Normal file
165
zomp/lib/otpr/zx/0.2.0/templates/licenses/lgpl3.txt
Normal file
@ -0,0 +1,165 @@
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser General Public License from time to time. Such new
|
||||
versions will be similar in spirit to the present version, but may
|
||||
differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
19
zomp/lib/otpr/zx/0.2.0/templates/licenses/mit.txt
Normal file
19
zomp/lib/otpr/zx/0.2.0/templates/licenses/mit.txt
Normal file
@ -0,0 +1,19 @@
|
||||
Copyright 〘*YEAR*〙 〘*COPYRIGHT HOLDER*〙
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
373
zomp/lib/otpr/zx/0.2.0/templates/licenses/mpl2.txt
Normal file
373
zomp/lib/otpr/zx/0.2.0/templates/licenses/mpl2.txt
Normal file
@ -0,0 +1,373 @@
|
||||
Mozilla Public License Version 2.0
|
||||
==================================
|
||||
|
||||
1. Definitions
|
||||
--------------
|
||||
|
||||
1.1. "Contributor"
|
||||
means each individual or legal entity that creates, contributes to
|
||||
the creation of, or owns Covered Software.
|
||||
|
||||
1.2. "Contributor Version"
|
||||
means the combination of the Contributions of others (if any) used
|
||||
by a Contributor and that particular Contributor's Contribution.
|
||||
|
||||
1.3. "Contribution"
|
||||
means Covered Software of a particular Contributor.
|
||||
|
||||
1.4. "Covered Software"
|
||||
means Source Code Form to which the initial Contributor has attached
|
||||
the notice in Exhibit A, the Executable Form of such Source Code
|
||||
Form, and Modifications of such Source Code Form, in each case
|
||||
including portions thereof.
|
||||
|
||||
1.5. "Incompatible With Secondary Licenses"
|
||||
means
|
||||
|
||||
(a) that the initial Contributor has attached the notice described
|
||||
in Exhibit B to the Covered Software; or
|
||||
|
||||
(b) that the Covered Software was made available under the terms of
|
||||
version 1.1 or earlier of the License, but not also under the
|
||||
terms of a Secondary License.
|
||||
|
||||
1.6. "Executable Form"
|
||||
means any form of the work other than Source Code Form.
|
||||
|
||||
1.7. "Larger Work"
|
||||
means a work that combines Covered Software with other material, in
|
||||
a separate file or files, that is not Covered Software.
|
||||
|
||||
1.8. "License"
|
||||
means this document.
|
||||
|
||||
1.9. "Licensable"
|
||||
means having the right to grant, to the maximum extent possible,
|
||||
whether at the time of the initial grant or subsequently, any and
|
||||
all of the rights conveyed by this License.
|
||||
|
||||
1.10. "Modifications"
|
||||
means any of the following:
|
||||
|
||||
(a) any file in Source Code Form that results from an addition to,
|
||||
deletion from, or modification of the contents of Covered
|
||||
Software; or
|
||||
|
||||
(b) any new file in Source Code Form that contains any Covered
|
||||
Software.
|
||||
|
||||
1.11. "Patent Claims" of a Contributor
|
||||
means any patent claim(s), including without limitation, method,
|
||||
process, and apparatus claims, in any patent Licensable by such
|
||||
Contributor that would be infringed, but for the grant of the
|
||||
License, by the making, using, selling, offering for sale, having
|
||||
made, import, or transfer of either its Contributions or its
|
||||
Contributor Version.
|
||||
|
||||
1.12. "Secondary License"
|
||||
means either the GNU General Public License, Version 2.0, the GNU
|
||||
Lesser General Public License, Version 2.1, the GNU Affero General
|
||||
Public License, Version 3.0, or any later versions of those
|
||||
licenses.
|
||||
|
||||
1.13. "Source Code Form"
|
||||
means the form of the work preferred for making modifications.
|
||||
|
||||
1.14. "You" (or "Your")
|
||||
means an individual or a legal entity exercising rights under this
|
||||
License. For legal entities, "You" includes any entity that
|
||||
controls, is controlled by, or is under common control with You. For
|
||||
purposes of this definition, "control" means (a) the power, direct
|
||||
or indirect, to cause the direction or management of such entity,
|
||||
whether by contract or otherwise, or (b) ownership of more than
|
||||
fifty percent (50%) of the outstanding shares or beneficial
|
||||
ownership of such entity.
|
||||
|
||||
2. License Grants and Conditions
|
||||
--------------------------------
|
||||
|
||||
2.1. Grants
|
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||
non-exclusive license:
|
||||
|
||||
(a) under intellectual property rights (other than patent or trademark)
|
||||
Licensable by such Contributor to use, reproduce, make available,
|
||||
modify, display, perform, distribute, and otherwise exploit its
|
||||
Contributions, either on an unmodified basis, with Modifications, or
|
||||
as part of a Larger Work; and
|
||||
|
||||
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
||||
for sale, have made, import, and otherwise transfer either its
|
||||
Contributions or its Contributor Version.
|
||||
|
||||
2.2. Effective Date
|
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution
|
||||
become effective for each Contribution on the date the Contributor first
|
||||
distributes such Contribution.
|
||||
|
||||
2.3. Limitations on Grant Scope
|
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under
|
||||
this License. No additional rights or licenses will be implied from the
|
||||
distribution or licensing of Covered Software under this License.
|
||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||
Contributor:
|
||||
|
||||
(a) for any code that a Contributor has removed from Covered Software;
|
||||
or
|
||||
|
||||
(b) for infringements caused by: (i) Your and any other third party's
|
||||
modifications of Covered Software, or (ii) the combination of its
|
||||
Contributions with other software (except as part of its Contributor
|
||||
Version); or
|
||||
|
||||
(c) under Patent Claims infringed by Covered Software in the absence of
|
||||
its Contributions.
|
||||
|
||||
This License does not grant any rights in the trademarks, service marks,
|
||||
or logos of any Contributor (except as may be necessary to comply with
|
||||
the notice requirements in Section 3.4).
|
||||
|
||||
2.4. Subsequent Licenses
|
||||
|
||||
No Contributor makes additional grants as a result of Your choice to
|
||||
distribute the Covered Software under a subsequent version of this
|
||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||
permitted under the terms of Section 3.3).
|
||||
|
||||
2.5. Representation
|
||||
|
||||
Each Contributor represents that the Contributor believes its
|
||||
Contributions are its original creation(s) or it has sufficient rights
|
||||
to grant the rights to its Contributions conveyed by this License.
|
||||
|
||||
2.6. Fair Use
|
||||
|
||||
This License is not intended to limit any rights You have under
|
||||
applicable copyright doctrines of fair use, fair dealing, or other
|
||||
equivalents.
|
||||
|
||||
2.7. Conditions
|
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
||||
in Section 2.1.
|
||||
|
||||
3. Responsibilities
|
||||
-------------------
|
||||
|
||||
3.1. Distribution of Source Form
|
||||
|
||||
All distribution of Covered Software in Source Code Form, including any
|
||||
Modifications that You create or to which You contribute, must be under
|
||||
the terms of this License. You must inform recipients that the Source
|
||||
Code Form of the Covered Software is governed by the terms of this
|
||||
License, and how they can obtain a copy of this License. You may not
|
||||
attempt to alter or restrict the recipients' rights in the Source Code
|
||||
Form.
|
||||
|
||||
3.2. Distribution of Executable Form
|
||||
|
||||
If You distribute Covered Software in Executable Form then:
|
||||
|
||||
(a) such Covered Software must also be made available in Source Code
|
||||
Form, as described in Section 3.1, and You must inform recipients of
|
||||
the Executable Form how they can obtain a copy of such Source Code
|
||||
Form by reasonable means in a timely manner, at a charge no more
|
||||
than the cost of distribution to the recipient; and
|
||||
|
||||
(b) You may distribute such Executable Form under the terms of this
|
||||
License, or sublicense it under different terms, provided that the
|
||||
license for the Executable Form does not attempt to limit or alter
|
||||
the recipients' rights in the Source Code Form under this License.
|
||||
|
||||
3.3. Distribution of a Larger Work
|
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice,
|
||||
provided that You also comply with the requirements of this License for
|
||||
the Covered Software. If the Larger Work is a combination of Covered
|
||||
Software with a work governed by one or more Secondary Licenses, and the
|
||||
Covered Software is not Incompatible With Secondary Licenses, this
|
||||
License permits You to additionally distribute such Covered Software
|
||||
under the terms of such Secondary License(s), so that the recipient of
|
||||
the Larger Work may, at their option, further distribute the Covered
|
||||
Software under the terms of either this License or such Secondary
|
||||
License(s).
|
||||
|
||||
3.4. Notices
|
||||
|
||||
You may not remove or alter the substance of any license notices
|
||||
(including copyright notices, patent notices, disclaimers of warranty,
|
||||
or limitations of liability) contained within the Source Code Form of
|
||||
the Covered Software, except that You may alter any license notices to
|
||||
the extent required to remedy known factual inaccuracies.
|
||||
|
||||
3.5. Application of Additional Terms
|
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support,
|
||||
indemnity or liability obligations to one or more recipients of Covered
|
||||
Software. However, You may do so only on Your own behalf, and not on
|
||||
behalf of any Contributor. You must make it absolutely clear that any
|
||||
such warranty, support, indemnity, or liability obligation is offered by
|
||||
You alone, and You hereby agree to indemnify every Contributor for any
|
||||
liability incurred by such Contributor as a result of warranty, support,
|
||||
indemnity or liability terms You offer. You may include additional
|
||||
disclaimers of warranty and limitations of liability specific to any
|
||||
jurisdiction.
|
||||
|
||||
4. Inability to Comply Due to Statute or Regulation
|
||||
---------------------------------------------------
|
||||
|
||||
If it is impossible for You to comply with any of the terms of this
|
||||
License with respect to some or all of the Covered Software due to
|
||||
statute, judicial order, or regulation then You must: (a) comply with
|
||||
the terms of this License to the maximum extent possible; and (b)
|
||||
describe the limitations and the code they affect. Such description must
|
||||
be placed in a text file included with all distributions of the Covered
|
||||
Software under this License. Except to the extent prohibited by statute
|
||||
or regulation, such description must be sufficiently detailed for a
|
||||
recipient of ordinary skill to be able to understand it.
|
||||
|
||||
5. Termination
|
||||
--------------
|
||||
|
||||
5.1. The rights granted under this License will terminate automatically
|
||||
if You fail to comply with any of its terms. However, if You become
|
||||
compliant, then the rights granted under this License from a particular
|
||||
Contributor are reinstated (a) provisionally, unless and until such
|
||||
Contributor explicitly and finally terminates Your grants, and (b) on an
|
||||
ongoing basis, if such Contributor fails to notify You of the
|
||||
non-compliance by some reasonable means prior to 60 days after You have
|
||||
come back into compliance. Moreover, Your grants from a particular
|
||||
Contributor are reinstated on an ongoing basis if such Contributor
|
||||
notifies You of the non-compliance by some reasonable means, this is the
|
||||
first time You have received notice of non-compliance with this License
|
||||
from such Contributor, and You become compliant prior to 30 days after
|
||||
Your receipt of the notice.
|
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent
|
||||
infringement claim (excluding declaratory judgment actions,
|
||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||
directly or indirectly infringes any patent, then the rights granted to
|
||||
You by any and all Contributors for the Covered Software under Section
|
||||
2.1 of this License shall terminate.
|
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
||||
end user license agreements (excluding distributors and resellers) which
|
||||
have been validly granted by You or Your distributors under this License
|
||||
prior to termination shall survive termination.
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 6. Disclaimer of Warranty *
|
||||
* ------------------------- *
|
||||
* *
|
||||
* Covered Software is provided under this License on an "as is" *
|
||||
* basis, without warranty of any kind, either expressed, implied, or *
|
||||
* statutory, including, without limitation, warranties that the *
|
||||
* Covered Software is free of defects, merchantable, fit for a *
|
||||
* particular purpose or non-infringing. The entire risk as to the *
|
||||
* quality and performance of the Covered Software is with You. *
|
||||
* Should any Covered Software prove defective in any respect, You *
|
||||
* (not any Contributor) assume the cost of any necessary servicing, *
|
||||
* repair, or correction. This disclaimer of warranty constitutes an *
|
||||
* essential part of this License. No use of any Covered Software is *
|
||||
* authorized under this License except under this disclaimer. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 7. Limitation of Liability *
|
||||
* -------------------------- *
|
||||
* *
|
||||
* Under no circumstances and under no legal theory, whether tort *
|
||||
* (including negligence), contract, or otherwise, shall any *
|
||||
* Contributor, or anyone who distributes Covered Software as *
|
||||
* permitted above, be liable to You for any direct, indirect, *
|
||||
* special, incidental, or consequential damages of any character *
|
||||
* including, without limitation, damages for lost profits, loss of *
|
||||
* goodwill, work stoppage, computer failure or malfunction, or any *
|
||||
* and all other commercial damages or losses, even if such party *
|
||||
* shall have been informed of the possibility of such damages. This *
|
||||
* limitation of liability shall not apply to liability for death or *
|
||||
* personal injury resulting from such party's negligence to the *
|
||||
* extent applicable law prohibits such limitation. Some *
|
||||
* jurisdictions do not allow the exclusion or limitation of *
|
||||
* incidental or consequential damages, so this exclusion and *
|
||||
* limitation may not apply to You. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
8. Litigation
|
||||
-------------
|
||||
|
||||
Any litigation relating to this License may be brought only in the
|
||||
courts of a jurisdiction where the defendant maintains its principal
|
||||
place of business and such litigation shall be governed by laws of that
|
||||
jurisdiction, without reference to its conflict-of-law provisions.
|
||||
Nothing in this Section shall prevent a party's ability to bring
|
||||
cross-claims or counter-claims.
|
||||
|
||||
9. Miscellaneous
|
||||
----------------
|
||||
|
||||
This License represents the complete agreement concerning the subject
|
||||
matter hereof. If any provision of this License is held to be
|
||||
unenforceable, such provision shall be reformed only to the extent
|
||||
necessary to make it enforceable. Any law or regulation which provides
|
||||
that the language of a contract shall be construed against the drafter
|
||||
shall not be used to construe this License against a Contributor.
|
||||
|
||||
10. Versions of the License
|
||||
---------------------------
|
||||
|
||||
10.1. New Versions
|
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section
|
||||
10.3, no one other than the license steward has the right to modify or
|
||||
publish new versions of this License. Each version will be given a
|
||||
distinguishing version number.
|
||||
|
||||
10.2. Effect of New Versions
|
||||
|
||||
You may distribute the Covered Software under the terms of the version
|
||||
of the License under which You originally received the Covered Software,
|
||||
or under the terms of any subsequent version published by the license
|
||||
steward.
|
||||
|
||||
10.3. Modified Versions
|
||||
|
||||
If you create software not governed by this License, and you want to
|
||||
create a new license for such software, you may create and use a
|
||||
modified version of this License if you rename the license and remove
|
||||
any references to the name of the license steward (except to note that
|
||||
such modified license differs from this License).
|
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||
Licenses
|
||||
|
||||
If You choose to distribute Source Code Form that is Incompatible With
|
||||
Secondary Licenses under the terms of this version of the License, the
|
||||
notice described in Exhibit B of this License must be attached.
|
||||
|
||||
Exhibit A - Source Code Form License Notice
|
||||
-------------------------------------------
|
||||
|
||||
This Source Code Form is subject to the terms of the Mozilla Public
|
||||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
|
||||
If it is not possible or desirable to put the notice in a particular
|
||||
file, then You may include the notice in a location (such as a LICENSE
|
||||
file in a relevant directory) where a recipient would be likely to look
|
||||
for such a notice.
|
||||
|
||||
You may add additional accurate notices of copyright ownership.
|
||||
|
||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||
---------------------------------------------------------
|
||||
|
||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||
defined by the Mozilla Public License, v. 2.0.
|
||||
24
zomp/lib/otpr/zx/0.2.0/templates/simplecli.erl
Normal file
24
zomp/lib/otpr/zx/0.2.0/templates/simplecli.erl
Normal file
@ -0,0 +1,24 @@
|
||||
%%% @doc
|
||||
%%% 〘*PROJECT NAME*〙: 〘*MODULE*〙
|
||||
%%%
|
||||
%%% This module is currently named `〘*APP MOD*〙', but you may want to change that.
|
||||
%%% Remember that changing the name in `-module()' below requires renaming
|
||||
%%% this file, and it is recommended to run `zx update .app` in the main
|
||||
%%% project directory to make sure the ebin/〘*APP MOD*〙.app file stays in
|
||||
%%% sync with the project whenever you add, remove or rename a module.
|
||||
%%% @end
|
||||
|
||||
-module(〘*MODULE*〙).
|
||||
〘*AUTHOR*〙
|
||||
〘*COPYRIGHT*〙
|
||||
〘*LICENSE*〙
|
||||
|
||||
-export([start/1]).
|
||||
|
||||
|
||||
-spec start(ArgV) -> ok
|
||||
when ArgV :: [string()].
|
||||
|
||||
start(ArgV) ->
|
||||
ok = io:format("Hello, World! Args: ~tp~n", [ArgV]),
|
||||
zx:silent_stop().
|
||||
Loading…
x
Reference in New Issue
Block a user