Clean things up and update code

Signed-off-by: Krzysztof Wilczyński <[email protected]>

Author: kwilczynski

COPYRIGHT

@@ -1 +1 @@
-Copyright 2013-2020 Krzysztof Wilczyński
+Copyright 2013-2021 Krzysztof Wilczyński

README.md

@@ -33,7 +33,7 @@ Krzysztof Wilczyński (<kw@linux.com>)
 
 ## Copyright
 
-Copyright 2013-2020 Krzysztof Wilczyński
+Copyright 2013-2021 Krzysztof Wilczyński
 
 ## License
 

common.h

@@ -45,11 +45,11 @@ extern "C" {
 #endif
 
 #if !defined(MAGIC_NO_CHECK_CSV)
-# define MAGIC_NO_CHECK_CSV -1
+# define MAGIC_NO_CHECK_CSV 0
 #endif
 
 #if !defined(MAGIC_NO_CHECK_JSON)
-# define MAGIC_NO_CHECK_JSON -1
+# define MAGIC_NO_CHECK_JSON 0
 #endif
 
 #if defined(MAGIC_VERSION) && MAGIC_VERSION >= 532

constants_test.go

@@ -1,57 +1,40 @@
 package magic
 
-import (
-	"testing"
-)
+import "testing"
 
 func TestConstants(t *testing.T) {
 	var constantTests = []struct {
 		given    int
-		expected []int
+		expected int
 	}{
 		{
 			MIME,
-			[]int{
-				MIME_TYPE,
-				MIME_ENCODING,
-			},
+			MIME_TYPE | MIME_ENCODING,
 		},
 		{
 			NO_CHECK_ASCII,
-			[]int{
-				NO_CHECK_TEXT,
-			},
+			NO_CHECK_TEXT,
+		},
+		{
+			NO_CHECK_FORTRAN,
+			0,
+		},
+		{
+			NO_CHECK_TROFF,
+			0,
 		},
 		{
 			NO_CHECK_BUILTIN,
-			[]int{
-				NO_CHECK_COMPRESS,
-				NO_CHECK_TAR,
-				NO_CHECK_APPTYPE,
-				NO_CHECK_ELF,
-				NO_CHECK_TEXT,
-				NO_CHECK_CSV,
-				NO_CHECK_CDF,
-				NO_CHECK_TOKENS,
-				NO_CHECK_ENCODING,
-				NO_CHECK_JSON,
-			},
+			NO_CHECK_COMPRESS | NO_CHECK_TAR | NO_CHECK_APPTYPE | NO_CHECK_ELF | NO_CHECK_TEXT | NO_CHECK_CSV | NO_CHECK_CDF | NO_CHECK_TOKENS | NO_CHECK_ENCODING | NO_CHECK_JSON,
 		},
 	}
 
 	for _, tt := range constantTests {
-		expected := 0
-		for _, flag := range tt.expected {
-			if flag > -1 {
-				expected |= flag
-			}
-		}
-
-		if tt.given != expected {
-			t.Errorf("value given 0x%x, want 0x%x", tt.given, expected)
+		if tt.given != tt.expected {
+			t.Errorf("value given 0x%x, want 0x%x", tt.given, tt.expected)
 		}
 	}
 }
 
-func TestParameters(t *testing.T) {
-}
+// func TestParameters(t *testing.T) {
+// }

example_package_test.go

@@ -8,15 +8,15 @@ import (
 )
 
 // This example shows how to use the Separator to split results
-// when the CONTINUE flag is set and more than one match was
+// when the "CONTINUE" flag is set and more than one match was
 // returned by the Magic library.
 func Example_separator() {
 	buffer := []byte("#!/bin/bash\n\n")
 
-	// Open and load default Magic database ...
+	// Open and load the default Magic database.
 	m, err := magic.New()
 	if err != nil {
-		panic(fmt.Sprintf("An error occurred: %s\n", err))
+		panic(fmt.Sprintf("An has error occurred: %s\n", err))
 	}
 
 	m.SetFlags(magic.CONTINUE)
@@ -29,35 +29,35 @@ func Example_separator() {
 	for _, s := range strings.Split(result, magic.Separator) {
 		fmt.Printf("\t%s\n", s)
 	}
-
 	m.Close()
-	// Should output:
+	// Output:
 	// Matches for data in the buffer are:
-	//      Bourne-Again shell script text executable
-	//      a /bin/bash script, ASCII text executable
+	//	Bourne-Again shell script text executable
+	//	a /bin/bash script, ASCII text executable
 }
 
 // This example shows how to use Open together with a closure.
 func Example_closure() {
 	var s string
 
 	// When using magic.Open you don't have to worry
-	// about closing the underlying Magic database.
+	// about closing the the Magic database.
 	err := magic.Open(func(m *magic.Magic) error {
 		m.SetFlags(magic.MIME)
 		mime, err := m.File("test/fixtures/gopher.png")
 		if err != nil {
 			return err // Propagate error outside of the closure.
 		}
-		s = mime // Pass results outside ...
+		s = mime // Pass results outside.
 		return nil
 	})
-
 	if err != nil {
-		panic(fmt.Sprintf("An error occurred: %s\n", err))
+		panic(fmt.Sprintf("An has error occurred: %s\n", err))
 	}
-
 	fmt.Printf("File MIME type is: %s\n", s)
 	// Output:
 	// File MIME type is: image/png; charset=binary
 }
+
+// func Example_disable_autoload() {
+// }

example_test.go

@@ -7,14 +7,14 @@ import (
 )
 
 // This example show the basic usage of the package: Open and initialize
-// Magic library, set appropriate flags, for a given file find its MIME
-// identification (as per the flag set), print the results and close
+// the Magic library, set appropriate flags, for a given file find its
+// MIME identification (as per the flag set), print the results and close
 // releasing all initialized resources.
 func Example_basic() {
-	// Open and load default Magic database ...
+	// Open and load the default Magic database.
 	m, err := magic.New()
 	if err != nil {
-		panic(fmt.Sprintf("An error occurred: %s\n", err))
+		panic(fmt.Sprintf("An has error occurred: %s\n", err))
 	}
 
 	m.SetFlags(magic.MIME)
@@ -31,9 +31,12 @@ func Example_basic() {
 
 // This example shows how to quickly find MIME type for a file.
 func ExampleFileType() {
+	// The magic.FileType function will open the Magic database,
+	// set flags to "MIME", return the result, and then close
+	// the Magic database afterwards.
 	mime, err := magic.FileType("test/fixtures/gopher.png")
 	if err != nil {
-		panic(fmt.Sprintf("An error occurred: %s\n", err))
+		panic(fmt.Sprintf("An has error occurred: %s\n", err))
 	}
 	fmt.Printf("File MIME type is: %s\n", mime)
 	// Output:
@@ -46,7 +49,7 @@ func ExampleBufferEncoding() {
 
 	mime, err := magic.BufferEncoding(buffer)
 	if err != nil {
-		panic(fmt.Sprintf("An error occurred: %s\n", err))
+		panic(fmt.Sprintf("An has error occurred: %s\n", err))
 	}
 	fmt.Printf("Data in the buffer is encoded as: %s\n", mime)
 	// Output: