Merge b36ae53 into f2acaae

example/c_json/cjson_generated_bindings.dart

@@ -1,6 +1,26 @@
-/// AUTO GENERATED FILE, DO NOT EDIT.
-///
-/// Generated by `package:ffigen`.
+// Copyright (c) 2009-2017 Dave Gamble and cJSON contributors
+//
+// 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.
+
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Holds bindings to cJSON.

example/c_json/pubspec.yaml

@@ -24,3 +24,24 @@ ffigen:
     include-directives:
       - '**cJSON.h'
   comments: false
+
+  preamble: |
+    // Copyright (c) 2009-2017 Dave Gamble and cJSON contributors
+    //
+    // 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.

example/libclang-example/generated_bindings.dart

@@ -1,7 +1,11 @@
-/// AUTO GENERATED FILE, DO NOT EDIT.
-///
-/// Generated by `package:ffigen`.
-
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM
+// Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Holds bindings to LibClang.

example/libclang-example/pubspec.yaml

@@ -59,14 +59,15 @@ ffigen:
   # False by default.
   array-workaround: true
 
-  # The header of the file, this is pasted as it is.
-  preamble: |
-    /// AUTO GENERATED FILE, DO NOT EDIT.
-    ///
-    /// Generated by `package:ffigen`.
-
   # Doc Comments for generated binings.
   # Comments can be disabled by using comments: false
   comments:
     style: doxygen # Options - doxygen(default) / any.
     length: full # Options - brief / full(default).
+
+  # The header of the file, this is pasted as it is.
+  preamble: |
+    // Part of the LLVM Project, under the Apache License v2.0 with LLVM
+    // Exceptions.
+    // See https://llvm.org/LICENSE.txt for license information.
+    // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception

example/simple/generated_bindings.dart

@@ -1,6 +1,6 @@
-/// AUTO GENERATED FILE, DO NOT EDIT.
-///
-/// Generated by `package:ffigen`.
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Bindings to `headers/example.h`.

lib/src/code_generator/utils.dart

@@ -47,7 +47,7 @@ class UniqueNamer {
   UniqueNamer clone() => UniqueNamer._raw({..._usedUpNames});
 }
 
-/// Converts [text] to a dart doc comment.
+/// Converts [text] to a dart doc comment(`///`).
 ///
 /// Comment is split on new lines only.
 String makeDartDoc(String text) {
@@ -58,3 +58,15 @@ String makeDartDoc(String text) {
 
   return s.toString();
 }
+
+/// Converts [text] to a dart comment (`//`).
+///
+/// Comment is split on new lines only.
+String makeDoc(String text) {
+  final s = StringBuffer();
+  s.write('// ');
+  s.writeAll(text.split('\n'), '\n// ');
+  s.write('\n');
+
+  return s.toString();
+}

lib/src/code_generator/writer.dart

@@ -105,12 +105,12 @@ class Writer {
     if (header != null) {
       s.write(header);
       s.write('\n');
-    } else {
-      // Write default header, in case none was provided.
-      s.write(makeDartDoc(
-          'AUTO GENERATED FILE, DO NOT EDIT.\n\nGenerated by `package:ffigen`.'));
     }
 
+    // Write auto generated declaration.
+    s.write(makeDoc(
+        'AUTO GENERATED FILE, DO NOT EDIT.\n\nGenerated by `package:ffigen`.'));
+
     // Write neccesary imports.
     s.write("import 'dart:ffi' as $ffiLibraryPrefix;\n");
     s.write('\n');

lib/src/header_parser/clang_bindings/clang_bindings.dart

@@ -1,6 +1,11 @@
-/// AUTO GENERATED FILE, DO NOT EDIT.
-///
-/// Generated by `package:ffigen`.
+// Part of the LLVM Project, under the Apache License v2.0 with LLVM
+// Exceptions.
+// See https://llvm.org/LICENSE.txt for license information.
+// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Holds bindings to LibClang.

test/code_generator_test.dart

@@ -78,9 +78,9 @@ void main() {
         'test/debug_generated/Function-Binding-test-output.dart',
       );
       try {
-        expect(gen, '''/// AUTO GENERATED FILE, DO NOT EDIT.
-/// 
-/// Generated by `package:ffigen`.
+        expect(gen, '''// AUTO GENERATED FILE, DO NOT EDIT.
+// 
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 class Bindings{
@@ -232,9 +232,9 @@ typedef _dart_withPointerParam = ffi.Pointer<ffi.Double> Function(
       final file = File('test/debug_generated/Struct-Binding-test-output.dart');
 
       try {
-        expect(gen, '''/// AUTO GENERATED FILE, DO NOT EDIT.
-/// 
-/// Generated by `package:ffigen`.
+        expect(gen, '''// AUTO GENERATED FILE, DO NOT EDIT.
+// 
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Just a test struct
@@ -333,9 +333,9 @@ class WithPointerMember extends ffi.Struct{
           File('test/debug_generated/Func-n-Struct-Binding-test-output.dart');
       try {
         //expect
-        expect(gen, '''/// AUTO GENERATED FILE, DO NOT EDIT.
-/// 
-/// Generated by `package:ffigen`.
+        expect(gen, '''// AUTO GENERATED FILE, DO NOT EDIT.
+// 
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 class Bindings{
@@ -428,9 +428,9 @@ typedef _dart_someFunc = ffi.Pointer<SomeStruc> Function(
         'test/debug_generated/Global-Binding-test-output.dart',
       );
       try {
-        expect(gen, '''/// AUTO GENERATED FILE, DO NOT EDIT.
-/// 
-/// Generated by `package:ffigen`.
+        expect(gen, '''// AUTO GENERATED FILE, DO NOT EDIT.
+// 
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 class Bindings{
@@ -489,9 +489,9 @@ class Some extends ffi.Struct{
         'test/debug_generated/Constant-test-output.dart',
       );
       try {
-        expect(gen, '''/// AUTO GENERATED FILE, DO NOT EDIT.
-/// 
-/// Generated by `package:ffigen`.
+        expect(gen, '''// AUTO GENERATED FILE, DO NOT EDIT.
+// 
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 const int test1 = 20;
@@ -534,9 +534,9 @@ const double test2 = 20.0;
         'test/debug_generated/enum-class-test-output.dart',
       );
       try {
-        expect(gen, '''/// AUTO GENERATED FILE, DO NOT EDIT.
-/// 
-/// Generated by `package:ffigen`.
+        expect(gen, '''// AUTO GENERATED FILE, DO NOT EDIT.
+// 
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// test line 1
@@ -608,9 +608,9 @@ abstract class Constants {
         'test/debug_generated/internal-conflict-resolution.dart',
       );
       try {
-        expect(gen, r'''/// AUTO GENERATED FILE, DO NOT EDIT.
-/// 
-/// Generated by `package:ffigen`.
+        expect(gen, r'''// AUTO GENERATED FILE, DO NOT EDIT.
+// 
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 class init_dylib_1{

test/example_tests/cjson_example_test.dart

@@ -27,6 +27,26 @@ ${strings.headers}:
   ${strings.includeDirectives}:
     - '**cJSON.h'
 ${strings.comments}: false
+${strings.preamble}: |
+  // Copyright (c) 2009-2017 Dave Gamble and cJSON contributors
+  //
+  // 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.
 ''') as YamlMap);
       final library = parse(config);
 

test/example_tests/libclang_example_test.dart

@@ -42,13 +42,15 @@ ${strings.enums}:
 ${strings.name}: 'LibClang'
 ${strings.description}: 'Holds bindings to LibClang.'
 ${strings.arrayWorkaround}: true
-${strings.preamble}: |
-  /// AUTO GENERATED FILE, DO NOT EDIT.
-  ///
-  /// Generated by `package:ffigen`.
 ${strings.comments}:
   ${strings.style}: ${strings.doxygen}
   ${strings.length}: ${strings.full}
+
+${strings.preamble}: |
+  // Part of the LLVM Project, under the Apache License v2.0 with LLVM
+  // Exceptions.
+  // See https://llvm.org/LICENSE.txt for license information.
+  // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
 ''') as YamlMap);
       final library = parse(config);
 

test/large_integration_tests/_expected_cjson_bindings.dart

@@ -1,6 +1,6 @@
-/// AUTO GENERATED FILE, DO NOT EDIT.
-///
-/// Generated by `package:ffigen`.
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Bindings to Cjson.

test/large_integration_tests/_expected_libclang_bindings.dart

@@ -1,6 +1,6 @@
-/// AUTO GENERATED FILE, DO NOT EDIT.
-///
-/// Generated by `package:ffigen`.
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Bindings to LibClang.

test/large_integration_tests/_expected_sqlite_bindings.dart

@@ -1,6 +1,6 @@
-/// AUTO GENERATED FILE, DO NOT EDIT.
-///
-/// Generated by `package:ffigen`.
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Bindings to SQLite.

test/native_test/native_test_bindings.dart

@@ -1,6 +1,6 @@
-/// AUTO GENERATED FILE, DO NOT EDIT.
-///
-/// Generated by `package:ffigen`.
+// AUTO GENERATED FILE, DO NOT EDIT.
+//
+// Generated by `package:ffigen`.
 import 'dart:ffi' as ffi;
 
 /// Native tests.

third_party/cjson_library/license.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2009-2017 Dave Gamble and cJSON contributors
+
+  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.
+
+
+Files generated from cJSON source code are
+- example/c_json/cjson_generated_bindings.dart
+- test/large_integration_tests/_expected_cjson_bindings.dart