Merge pull request #8 from nkcsgexi/update-branch

Update Swift fork of cmark with upstream cmark repository

Author: tkremenek

.travis.yml

@@ -8,11 +8,17 @@ language: c
 compiler:
  - clang
  - gcc
+matrix:
+  include:
+  - os: linux
+    compiler: gcc
+    env: CMAKE_OPTIONS="-DCMARK_SHARED=OFF"
 addons:
   apt:
     # we need a more recent cmake than travis/linux provides (at least 2.8.9):
     sources:
     - kubuntu-backports
+    - kalakris-cmake
     packages:
     - cmake
     - python3
@@ -23,14 +29,10 @@ before_install:
      then
          echo "Building without python3, to make sure that works."
      fi
+
 script:
- - make
+ - (mkdir -p build && cd build && cmake $CMAKE_OPTIONS ..)
  - make test
- - |
-     if [ ${TRAVIS_OS_NAME:-'linux'} = 'linux' ]
-     then
-         make roundtrip_test
-     fi
  - |
      if [ ${TRAVIS_OS_NAME:-'linux'} = 'linux' ]
      then

CMakeLists.txt

@@ -1,5 +1,13 @@
-project(cmark)
 cmake_minimum_required(VERSION 2.8.9)
+
+# prevent ugly developer warnings because version is set directly, not through project()
+# it should be redone properly by using VERSION in project() if on CMake 3.x
+if(CMAKE_MAJOR_VERSION GREATER 2)
+    cmake_policy(SET CMP0048 OLD)
+endif()
+
+project(cmark)
+
 include("FindAsan.cmake")
 
 if("${CMAKE_SOURCE_DIR}" STREQUAL "${CMAKE_BINARY_DIR}")
@@ -9,14 +17,17 @@ endif()
 set(PROJECT_NAME "cmark")
 
 set(PROJECT_VERSION_MAJOR 0)
-set(PROJECT_VERSION_MINOR 22)
-set(PROJECT_VERSION_PATCH 0)
+set(PROJECT_VERSION_MINOR 28)
+set(PROJECT_VERSION_PATCH 3)
 set(PROJECT_VERSION ${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH} )
 
 option(CMARK_TESTS "Build cmark tests and enable testing" ON)
+option(CMARK_STATIC "Build static libcmark library" ON)
+option(CMARK_SHARED "Build shared libcmark library" ON)
+option(CMARK_LIB_FUZZER "Build libFuzzer fuzzing harness" OFF)
 
 add_subdirectory(src)
-if(CMARK_TESTS)
+if(CMARK_TESTS AND (CMARK_SHARED OR CMARK_STATIC))
   add_subdirectory(api_test)
 endif()
 add_subdirectory(man)

COPYING

@@ -27,8 +27,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 -----
 
-houdini.h, houdini_href_e.c, houdini_html_e.c, houdini_html_u.c,
-html_unescape.gperf, html_unescape.h
+houdini.h, houdini_href_e.c, houdini_html_e.c, houdini_html_u.c
 
 derive from https://github.com/vmg/houdini (with some modifications)
 
@@ -104,7 +103,7 @@ DEALINGS IN THE SOFTWARE.
 
 -----
 
-The normalization code in runtests.py was derived from the
+The normalization code in normalize.py was derived from the
 markdowntest project, Copyright 2013 Karl Dubost:
 
 The MIT License (MIT)
@@ -169,24 +168,3 @@ 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.
-
------
-
-The normalization code in runtests.py was derived from the
-markdowntest project, Copyright 2013 Karl Dubost:
-
-The MIT License (MIT)
-
-Copyright (c) 2013 Karl Dubost
-
-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.

Makefile

@@ -9,25 +9,28 @@ SITE=_site
 SPECVERSION=$(shell perl -ne 'print $$1 if /^version: *([0-9.]+)/' $(SPEC))
 FUZZCHARS?=2000000  # for fuzztest
 BENCHDIR=bench
+BENCHSAMPLES=$(wildcard $(BENCHDIR)/samples/*.md)
 BENCHFILE=$(BENCHDIR)/benchinput.md
 ALLTESTS=alltests.md
 NUMRUNS?=10
 CMARK=$(BUILDDIR)/src/cmark
+CMARK_FUZZ=$(BUILDDIR)/src/cmark-fuzz
 PROG?=$(CMARK)
-BENCHINP?=README.md
 VERSION?=$(SPECVERSION)
 RELEASE?=CommonMark-$(VERSION)
 INSTALL_PREFIX?=/usr/local
 CLANG_CHECK?=clang-check
+CLANG_FORMAT=clang-format -style llvm -sort-includes=0 -i
+AFL_PATH?=/usr/local/bin
 
-.PHONY: all cmake_build spec leakcheck clean fuzztest dingus upload test update-site upload-site debug ubsan asan mingw archive bench format update-spec afl clang-check
+.PHONY: all cmake_build leakcheck clean fuzztest test debug ubsan asan mingw archive newbench bench format update-spec afl clang-check libFuzzer
 
 all: cmake_build man/man3/cmark.3
 
 $(CMARK): cmake_build
 
 cmake_build: $(BUILDDIR)
-	@make -j2 -C $(BUILDDIR)
+	@$(MAKE) -j2 -C $(BUILDDIR)
 	@echo "Binaries can be found in $(BUILDDIR)/src"
 
 $(BUILDDIR):
@@ -41,52 +44,59 @@ $(BUILDDIR):
 		-DCMAKE_EXPORT_COMPILE_COMMANDS=ON
 
 install: $(BUILDDIR)
-	make -C $(BUILDDIR) install
+	$(MAKE) -C $(BUILDDIR) install
 
 debug:
 	mkdir -p $(BUILDDIR); \
 	cd $(BUILDDIR); \
 	cmake .. -DCMAKE_BUILD_TYPE=Debug; \
-	make
+	$(MAKE)
 
 ubsan:
 	mkdir -p $(BUILDDIR); \
 	cd $(BUILDDIR); \
 	cmake .. -DCMAKE_BUILD_TYPE=Ubsan; \
-	make
+	$(MAKE)
 
 asan:
 	mkdir -p $(BUILDDIR); \
 	cd $(BUILDDIR); \
 	cmake .. -DCMAKE_BUILD_TYPE=Asan; \
-	make
+	$(MAKE)
 
 prof:
 	mkdir -p $(BUILDDIR); \
 	cd $(BUILDDIR); \
 	cmake .. -DCMAKE_BUILD_TYPE=Profile; \
-	make
+	$(MAKE)
 
 afl:
 	@[ -n "$(AFL_PATH)" ] || { echo '$$AFL_PATH not set'; false; }
 	mkdir -p $(BUILDDIR)
-	cd $(BUILDDIR) && cmake .. -DCMAKE_C_COMPILER=$(AFL_PATH)/afl-gcc
-	make
+	cd $(BUILDDIR) && cmake .. -DCMAKE_C_COMPILER=$(AFL_PATH)/afl-clang
+	$(MAKE)
 	$(AFL_PATH)/afl-fuzz \
 	    -i test/afl_test_cases \
 	    -o test/afl_results \
-	    -x test/afl_dictionary \
+	    -x test/fuzzing_dictionary \
 	    -t 100 \
 	    $(CMARK) $(CMARK_OPTS)
 
+libFuzzer:
+	@[ -n "$(LIB_FUZZER_PATH)" ] || { echo '$$LIB_FUZZER_PATH not set'; false; }
+	mkdir -p $(BUILDDIR)
+	cd $(BUILDDIR) && cmake -DCMAKE_BUILD_TYPE=Asan -DCMARK_LIB_FUZZER=ON -DCMAKE_LIB_FUZZER_PATH=$(LIB_FUZZER_PATH) ..
+	$(MAKE) -j2 -C $(BUILDDIR) cmark-fuzz
+	test/run-cmark-fuzz $(CMARK_FUZZ)
+
 clang-check: all
 	${CLANG_CHECK} -p build -analyze src/*.c
 
 mingw:
 	mkdir -p $(MINGW_BUILDDIR); \
 	cd $(MINGW_BUILDDIR); \
 	cmake .. -DCMAKE_TOOLCHAIN_FILE=../toolchain-mingw32.cmake -DCMAKE_INSTALL_PREFIX=$(MINGW_INSTALLDIR) ;\
-	make && make install
+	$(MAKE) && $(MAKE) install
 
 man/man3/cmark.3: src/cmark.h | $(CMARK)
 	python man/make_man_page.py $< > $@ \
@@ -100,22 +110,21 @@ clean:
 
 # We include case_fold_switch.inc in the repository, so this shouldn't
 # normally need to be generated.
-$(SRCDIR)/case_fold_switch.inc: $(DATADIR)/CaseFolding-3.2.0.txt
+$(SRCDIR)/case_fold_switch.inc: $(DATADIR)/CaseFolding.txt
 	perl tools/mkcasefold.pl < $< > $@
 
 # We include scanners.c in the repository, so this shouldn't
 # normally need to be generated.
 $(SRCDIR)/scanners.c: $(SRCDIR)/scanners.re
 	@case "$$(re2c -v)" in \
-	    *\ 0.13.7*|*\ 0.14|*\ 0.14.1) \
-		echo "re2c versions 0.13.7 through 0.14.1 are known to produce buggy code."; \
-		echo "Try a version >= 0.14.2 or <= 0.13.6."; \
+	    *\ 0.13.*|*\ 0.14|*\ 0.14.1) \
+		echo "re2c >= 0.14.2 is required"; \
 		false; \
 		;; \
 	esac
-	re2c --case-insensitive -b -i --no-generation-date -8 \
+	re2c -W -Werror --case-insensitive -b -i --no-generation-date -8 \
 		--encoding-policy substitute -o $@ $<
-	clang-format -style llvm -i $@
+	$(CLANG_FORMAT) $@
 
 # We include entities.inc in the repository, so normally this
 # doesn't need to be regenerated:
@@ -127,23 +136,18 @@ update-spec:
  > $(SPEC)
 
 test: $(SPEC) cmake_build
-	make -C $(BUILDDIR) test || (cat $(BUILDDIR)/Testing/Temporary/LastTest.log && exit 1)
-
-roundtrip_test: $(SPEC) cmake_build
-	python3 test/spec_tests.py --spec $< --prog test/roundtrip.sh
+	$(MAKE) -C $(BUILDDIR) test || (cat $(BUILDDIR)/Testing/Temporary/LastTest.log && exit 1)
 
 $(ALLTESTS): $(SPEC)
 	python3 test/spec_tests.py --spec $< --dump-tests | python3 -c 'import json; import sys; tests = json.loads(sys.stdin.read()); print("\n".join([test["markdown"] for test in tests]))' > $@
 
 leakcheck: $(ALLTESTS)
-	rc=0; \
 	for format in html man xml latex commonmark; do \
-	  for opts in "" "--smart" "--normalize"; do \
+	  for opts in "" "--smart"; do \
 	     echo "cmark -t $$format $$opts" ; \
-	     cat $< | valgrind -q --leak-check=full --dsymutil=yes --error-exitcode=1 $(PROG) -t $$format $$opts >/dev/null || rc=1; \
+	     valgrind -q --leak-check=full --dsymutil=yes --error-exitcode=1 $(PROG) -t $$format $$opts $(ALLTESTS) >/dev/null || exit 1;\
           done; \
-	done; \
-	exit $$rc
+	done;
 
 fuzztest:
 	{ for i in `seq 1 10`; do \
@@ -154,25 +158,39 @@ fuzztest:
 progit:
 	git clone https://github.com/progit/progit.git
 
-$(BENCHDIR)/benchinput.md: progit
+$(BENCHFILE): progit
 	echo "" > $@
 	for lang in ar az be ca cs de en eo es es-ni fa fi fr hi hu id it ja ko mk nl no-nb pl pt-br ro ru sr th tr uk vi zh zh-tw; do \
-		cat progit/$$lang/*/*.markdown >> $@; \
+		for i in `seq 1 10`; do \
+			cat progit/$$lang/*/*.markdown >> $@; \
+		done; \
 	done
 
+# for more accurate results, run with
+# sudo renice -10 $$; make bench
 bench: $(BENCHFILE)
-	{ sudo renice -10 $$$$; \
-	  for x in `seq 1 $(NUMRUNS)` ; do \
-	  /usr/bin/env time -p $(PROG) </dev/null >/dev/null ; \
-	  /usr/bin/env time -p $(PROG) $< >/dev/null ; \
-		  done \
+	{ for x in `seq 1 $(NUMRUNS)` ; do \
+		/usr/bin/env time -p $(PROG) </dev/null >/dev/null ; \
+		/usr/bin/env time -p $(PROG) $< >/dev/null ; \
+		done \
 	} 2>&1  | grep 'real' | awk '{print $$2}' | python3 'bench/stats.py'
 
+newbench:
+	for f in $(BENCHSAMPLES) ; do \
+	  printf "%26s  " `basename $$f` ; \
+	  { for x in `seq 1 $(NUMRUNS)` ; do \
+		/usr/bin/env time -p $(PROG) </dev/null >/dev/null ; \
+		for x in `seq 1 200` ; do cat $$f ; done | \
+		  /usr/bin/env time -p $(PROG) > /dev/null; \
+		done \
+	  } 2>&1  | grep 'real' | awk '{print $$2}' | \
+	    python3 'bench/stats.py'; done
+
 format:
-	clang-format -style llvm -i src/*.c src/*.h
+	$(CLANG_FORMAT) src/*.c src/*.h api_test/*.c api_test/*.h
 
 operf: $(CMARK)
-	operf $< < $(BENCHINP) > /dev/null
+	operf $< < $(BENCHFILE) > /dev/null
 
 distclean: clean
 	-rm -rf *.dSYM