Initial commit of project src files.

.gitignore

@@ -1,5 +1,9 @@
+*.swp
 .eunit
 deps
 *.o
 *.beam
-*.plt
+*.plt
+ebin
+doc
+.vim

LICENSE

@@ -0,0 +1,178 @@
+
+                                 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
+

Makefile

@@ -0,0 +1,30 @@
+EAOP_HOME = .
+EBIN = ${EAOP_HOME}/ebin
+SRC = ${EAOP_HOME}/src
+
+MODS = eaop eaopcore eaoputil eaopweaver
+
+all: compile erl
+
+erl:
+	erl -pa ${EBIN}
+
+ebin:
+	mkdir ${EBIN}
+
+compile: ebin ${MODS:%=${EBIN}/%.beam}
+
+${EBIN}/eaop.beam: ${SRC}/eaop.erl
+	erlc -o ${EBIN} ${SRC}/eaop.erl
+
+${EBIN}/eaopcore.beam: ${SRC}/eaopcore.erl
+	erlc -o ${EBIN} ${SRC}/eaopcore.erl
+
+${EBIN}/eaoputil.beam: ${SRC}/eaoputil.erl
+	erlc -o ${EBIN} ${SRC}/eaoputil.erl
+
+${EBIN}/eaopweaver.beam: ${SRC}/eaopweaver.erl
+	erlc -o ${EBIN} ${SRC}/eaopweaver.erl
+clean:
+	rm -rf ${EBIN}/*.beam ${EBIN}/erl_crash.dump
+	rmdir ${EBIN}

README.md

@@ -1,4 +1,10 @@
 eaop
 ====
 
-Compile time AOP implementation for Erlang
+Compile time AOP implementation for Erlang.
+
+This project was inspired by [ErlAOP](http://sourceforge.net/projects/erlaop/), which was written by Alexei Krasnopolski. Most of the ErlAOP documentation is relevant to this project.
+
+eaop re-implements the functionality of ErlAOP using [erl_syntax](http://erlang.org/doc/man/erl_syntax.html) and should not be dependent on the abstract forms generated by the Erlang compiler. However, both ErlAOP and eaop are implemented using Erlang's [parse_transform/2](http://www.erlang.org/doc/man/erl_id_trans.html) mechanism, making both of them limited to compile time weaving of code.
+
+eaop also extends the expressiveness of pointcut definitions, allowing the specification of send and receive operations in Erlang code to be eligible points for code weaving.

include/eaopglobals.hrl

@@ -0,0 +1,8 @@
+%% The weaver module.
+-define(WEAVER, eaopweaver).
+
+%% The core module.
+-define(CORE, eaopcore).
+
+%% The utility module.
+-define(UTIL, eaoputil).

include/unit_testing.hrl

@@ -0,0 +1,6 @@
+%% Commenting NOTEST will remove tests when compiling. Keep this definition before the inclusion of eunit.hrl.
+-define(NOTEST, true).
+
+-ifdef(EUNIT).
+-include_lib("eunit/include/eunit.hrl").
+-endif.

src/eaop.erl

@@ -0,0 +1,129 @@
+%%
+%% Copyright (C) 2013 by [email protected] (Justin Calleja)
+%%
+%% 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.
+%%
+
+%% Author: Justin Calleja
+%% Description: This module is an interface to the user of eaop. Compilation is done through this module.
+-module(eaop).
+
+-include("../include/eaopglobals.hrl").
+-include("../include/unit_testing.hrl").
+
+%%
+%% Exported Functions
+%%
+%% -export([]).
+-compile(export_all).
+
+%%
+%% API Functions
+%%
+
+-spec compile(Srcs::[string()], Configs::[string()]) -> ok.
+%% @todo Add the throws which can be thrown by functions executed within this function
+%% ( e.g. {ambiguous_ptcut_type, [ptcut_t()]} ).
+%% @doc
+%%		Srcs = list of directory names containing source files and/or file names.
+%%		Configs = list of directory names containing config files and/or config file names.
+%% Compiles the source files (*.erl) explicitly listed or found in the directories listed in Srcs.
+%% AOP weaving is done during the compilation stage using the configuration found in the config files
+%% explicitly listed or found within the directories listed in Configs. The default file suffix to identify
+%% a file as being a config file is .adf.
+%% (Note: given any directory, all sub-directories are searched recursively for source/config files to use in
+%% the compilation).
+compile(Srcs, Configs) ->
+	compile(Srcs, Configs, []).
+
+-spec compile(Srcs::[string()], Configs::[string()], Options::[term()]) -> ok.
+%% @throws TODO
+%% @doc
+%%		Srcs = list of directory names containing source files and/or file names.
+%%		Configs = list of directory names containing config files and/or config file names.
+%%		Options = Options determine the behavior of the compiler as defined in compile:file/2.
+%%			Additional options include:
+%%				{config_suffix, Suffix}: used to change the default (.adf) suffix of aspect definition files for this compilation. 
+%%				{print_gen_src, Dir}: this option prints the transformed source files after weaving in the directory Dir. 
+%% Same as eaop:compile/2 but takes a list of options.
+compile([], _, _) ->
+	ok;
+compile(Srcs, Configs, Options) ->
+	SrcFiles = get_files(Srcs, ".*\.erl$"),
+	Suffix =
+		case lists:keyfind(config_suffix, 1, Options) of
+			false ->
+				".*\.adf$";
+			{_, ConfigSuffix} ->
+				".*\." ++ ConfigSuffix ++ "$"
+		end,
+	ConfigFiles = get_files(Configs, Suffix),
+	Aspects = read_aspects(ConfigFiles),
+	Opts = ?WEAVER:make_options(Aspects, Options),
+	compile_files(SrcFiles, Opts).
+
+%% @doc compile_aspects/2 can be used when you have the aspects themselves and don't need to process .adf files. If building the aspects programmatically, this is probably the function you'd want to use.
+compile_aspects(Srcs, Aspects) ->
+	compile_aspects(Srcs, Aspects, []).
+
+%% @doc Similar to compile_aspects/2 but with options.
+compile_aspects(Srcs, Aspects, Options) ->
+	SrcFiles = get_files(Srcs, ".*\.erl$"),
+	Weaver = get_weaver_module(Options),
+	Opts = Weaver:make_options(Aspects, Options),
+	compile_files(SrcFiles, Opts).
+
+get_weaver_module(Options) ->
+	proplists:get_value(weaver, Options, ?WEAVER).
+
+-type file_or_dir() :: filelib:filename() | filelib:dirname().
+-spec get_files([FileOrDirName::file_or_dir()], SuffixRegex::string()) -> [filelib:filename()].
+get_files(FilesAndOrDirs, Suffix) ->
+	lists:append(
+	  [	case filelib:is_dir(FileOrDir) of
+			true ->
+				filelib:fold_files(FileOrDir, Suffix, true, fun(F, Acc) -> [F | Acc] end, []);
+			false ->
+				[FileOrDir]
+		end || FileOrDir <- FilesAndOrDirs	]).
+
+%% Note: the type compile_res() is actually whatever compile:file/2 is capable of returning.
+-type compile_res() ::  {ok, module()} | {ok, module(), Warnings::[term()]} | {ok, module(), binary()} | {ok, module(), binary(), Warnings::[term()]} | {error, Errors::[term()], Warnings::[term()]} | error.
+-spec compile_files(SrcFiles::[file:name()], Options::[?WEAVER:eaop_compile_opt()]) -> [{SrcFile::file:name(), CompileResult::compile_res()}].
+compile_files(SrcFiles, Options) ->
+	lists:foldl(
+		fun(S, Results) ->
+				CompileRes = compile:file(S, Options),
+				[{S, CompileRes} | Results]
+		end, [], SrcFiles).
+
+
+%%
+%% Local Functions
+%%
+
+-spec read_aspects(ConfigFiles::[file:name()]) -> [?CORE:aspect()].
+read_aspects(ConfigFiles) ->
+	?CORE:prepare_aspects_for_weaving(read_globals(ConfigFiles)).
+
+-spec read_globals(ConfigFiles::[file:name()]) -> ?CORE:globals().
+read_globals(ConfigFiles) ->
+	?CORE:get_globals(read_configs(ConfigFiles)).
+
+-spec read_configs([file:name()]) -> [?CORE:aop_el()].
+read_configs(Files) ->
+	lists:foldl(
+		fun(File, Adfs) ->
+				{ok, Adf} = file:consult(File),
+				lists:append(Adfs, Adf)
+		end, [], Files).