First commit for open source. Starting at v0.5.0

.gitignore

@@ -0,0 +1,55 @@
+.DS_Store
+Makefile.global
+Makefile.fragments
+Makefile.objects
+Makefile
+ac*
+autom4te.cache
+build
+config.guess
+config.h*
+config.log
+config.nice
+config.status
+config.sub
+configure*
+include
+install-sh
+libtool
+ltmain.sh
+missing
+mkinstalldirs
+modules
+run-tests.php
+safe_array_lookup.l*
+phpdoc/phpdoct
+vg*
+.idea
+.libs
+.deps
+sal_intellij_module
+*.iml
+*.la
+*.lo
+*.a
+*.tab.cpp
+*.tab.hpp
+*.yacc.cpp
+*.yacc.hpp
+*.lex.cpp
+*.lex.hpp
+*.yacc.output
+*.yy.cpp
+*.loT
+*.o
+*.so
+*.dot
+*.output
+tests/*.diff
+tests/*.php
+tests/*.exp
+tests/*.log
+tests/*.out
+tests/*.sh
+TODO
+private/*

CONTRIBUTING.md

@@ -0,0 +1,75 @@
+# Contributing
+
+All contributions are welcome to this project.
+
+## Contributor License Agreement
+
+Before a contribution can be merged into this project, please fill out the Contributor License Agreement (CLA) located at:
+
+http://opensource.box.com/cla
+
+To learn more about CLAs and why they are important to open source projects, please see the [Wikipedia entry](http://en.wikipedia.org/wiki/Contributor_License_Agreement).
+
+## How to contribute
+
+* **File an issue** - if you found a bug, want to request an enhancement, or want to implement something (bug fix or feature).
+* **Send a pull request** - if you want to contribute code. Please be sure to file an issue first.
+
+## Pull request best practices
+
+We want to accept your pull requests. Please follow these steps:
+
+### Step 1: File an issue
+
+Before writing any code, please file an issue stating the problem you want to solve or the feature you want to implement. This allows us to give you feedback before you spend any time writing code. There may be a known limitation that can't be addressed, or a bug that has already been fixed in a different way. The issue allows us to communicate and figure out if it's worth your time to write a bunch of code for the project.
+
+### Step 2: Fork this repository in GitHub
+
+This will create your own copy of our repository.
+
+### Step 3: Add the upstream source
+
+The upstream source is the project under the Box organization on GitHub. To add an upstream source for this project, type:
+
+```
+git remote add upstream git@github.com:box/augmented_types.git
+```
+
+This will come in useful later.
+
+### Step 4: Create a feature branch
+
+Create a branch with a descriptive name, such as `add-search`.
+
+### Step 5: Push your feature branch to your fork
+
+As you develop code, continue to push code to your remote feature branch. Please make sure to include the issue number you're addressing in your commit message, such as:
+
+```
+git commit -m "Adding search (fixes #123)"
+```
+
+This helps us out by allowing us to track which issue your commit relates to.
+
+Keep a separate feature branch for each issue you want to address.
+
+### Step 6: Rebase
+
+Before sending a pull request, rebase against upstream, such as:
+
+```
+git fetch upstream
+git rebase upstream/master
+```
+
+This will add your changes on top of what's already in upstream, minimizing merge issues.
+
+### Step 7: Run the tests
+
+Make sure that all tests are passing before submitting a pull request.
+
+### Step 8: Send the pull request
+
+Send the pull request from your feature branch to us. Be sure to include a description that lets us know what work you did.
+
+Keep in mind that we like to see one issue addressed per pull request, as this helps keep our git history clean and we can more easily track down issues.

LICENSE

@@ -0,0 +1,166 @@
+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-parser-targets.frag

@@ -0,0 +1,7 @@
+PHPDOC_SHARED_DEPENDENCIES = $(srcdir)/phpdoc/libphpdoc.a
+PHPDOC_SHARED_LIBADD := ${PHPDOC_SHARED_LIBADD}
+$(srcdir)/augmented_types.cc: $(srcdir)/phpdoc/libphpdoc.a
+$(srcdir)/phpdoc/libphpdoc.a: FORCE
+	$(MAKE) $(MFLAGS) -C $(srcdir)/phpdoc libphpdoc.a INCLUDES="$(INCLUDES)"
+
+FORCE:

PHPDoc_Bison_Compiler.cc

@@ -0,0 +1,90 @@
+#include "PHPDoc_Bison_Compiler.h"
+#include "php_augmented_types.h"
+#include "augmented_annotation_compiler.h"
+
+#include "zend_exceptions.h"
+#include "zend_execute.h"
+#include "zend_compile.h"
+#include "ext/spl/spl_exceptions.h"
+
+extern int phpdocparse(PHPDoc_Function** f);
+
+typedef struct yy_buffer_state * YY_BUFFER_STATE;
+extern yy_buffer_state* phpdoc_scan_string(const char *);
+extern void phpdoc_delete_buffer(yy_buffer_state* st);
+
+/**
+ * Single entrypoint for compiling a function's annotations with flex + bison
+ * populates the zend_literal used for enforcement of this function in the 'literal' pointer
+ * returns SUCCESS or FAILURE
+ */
+int PHPDoc_Bison_Compiler::compileFunction(zend_op_array* op_array, zend_literal *literal)
+{
+	DPRINTF("Compiling function %s\n", op_array->function_name);
+	//DPRINTF("PHPDoc_Bison_Compiler doc_comment: %s\n", op_array->doc_comment);
+
+	PHPDoc_Function fn;
+	PHPDoc_Function *fnptr = &fn;
+	bool is_closure = strcmp(op_array->function_name, "{closure}") == 0;
+	bool is_constructor = strncmp(op_array->function_name, "__construct", 12) == 0;
+
+	// NOTE: we _only_ allow functions to _not_ specify valid PHPDoc when either
+	// the function is a closure OR the function is a constructor that has no arguments
+	// also, note that closures sometime erratically pick up random PHPDoc in code, so
+	// we just skip phpdoc on closures altogether now
+	bool function_should_be_enforced = !(is_closure || (is_constructor && op_array->num_args == 0));
+
+	// bail out early if this function doesn't need phpdoc,
+	// throw an appropriate error message otherwise
+	if (!function_should_be_enforced) {
+		return FAILURE;
+	} else if (!op_array->doc_comment) {
+		// Add an appropriate error string
+		if (is_constructor) {
+			fn.set_error_string("No phpdoc specified - all constructors with arguments require phpdoc. (Did you remember to use /** ?)");
+		} else {
+			fn.set_error_string("No phpdoc specified - all named functions require phpdoc. (Did you remember to use /** ?)");
+		}
+		throw_compilation_exception(op_array, fnptr);
+		return FAILURE;
+	}
+
+	YY_BUFFER_STATE state = phpdoc_scan_string(op_array->doc_comment);
+	int result = phpdocparse(&fnptr);
+	DPRINTF("phpdocparse returned %d\n", result);
+
+	// if the compilation failed, cleanup, throw an exception, and bail!
+	if (result != 0) {
+		phpdoc_delete_buffer(state);
+		throw_compilation_exception(op_array, &fn);
+		return FAILURE;
+	}
+
+	// enforce that all compiled functions other than __construct methods
+	// have return types.
+	if (is_constructor && !fn.get_return()) {
+		fn.set_return(new PHPDoc_Void_Type());
+	} else if (!fn.get_return()) {
+		fn.set_error_string("Return types must always be specified.");
+		phpdoc_delete_buffer(state);
+		throw_compilation_exception(op_array, &fn);
+		return FAILURE;
+	}
+
+	// dump all of the PHPDoc_Function into the zend_literal
+	*literal = fn.serialize();
+
+	// delete the buffer once we're done
+	phpdoc_delete_buffer(state);
+	return SUCCESS;
+}
+
+/**
+ * Throws an informative compilation fatal error
+ */
+void PHPDoc_Bison_Compiler::throw_compilation_exception(zend_op_array* op_array, PHPDoc_Function *fn)
+{
+	TSRMLS_FETCH();
+	zend_error(ATCG(compilation_error_level), "Function annotation compilation failed for function %s in file %s at line %u, error message: %s\n",
+			op_array->function_name, op_array->filename, op_array->line_start, fn->get_error_string());
+}