Merge branch 'master' into refactor/tokenizer

Author: c-lipka

.gitattributes

@@ -1,3 +1,14 @@
+# Override language auto-detection on GitHub.
 libraries/*             linguist-vendored
 distribution/**/*.inc   linguist-language=POV-Ray
+distribution/platform-specific/windows/Insert?Menu/*.txt linguist-language=POV-Ray
 **/*.pov                linguist-language=POV-Ray
+**/*.h                  linguist-language=C++
+source/povms/povms.h    linguist-language=C
+libraries/**/*.h        linguist-language=C
+libraries/boost/*.h     linguist-language=C++
+libraries/ilmbase/*.h   linguist-language=C++
+libraries/openexr/*.h   linguist-language=C++
+
+# Do not auto-merge version number file.
+source/base/version.h   -merge

README.md

@@ -5,7 +5,7 @@
 [![AppVeyor Build status](https://img.shields.io/appveyor/ci/c-lipka/povray-exwy4.svg?label=appveyor)](https://ci.appveyor.com/project/c-lipka/povray-exwy4 "AppVeyor: Windows Server 2012 with Visual Studio 2015")
 [![Travis CI Build Status](https://img.shields.io/travis/POV-Ray/povray.svg?label=travis%20ci)](https://travis-ci.org/POV-Ray/povray "Travis CI: Ubuntu 12.04 LTE 64-bit with gcc 4.6; OS X 10.11 with clang 4.2")
 [![Coverity Code Analysis](https://scan.coverity.com/projects/269/badge.svg)](https://scan.coverity.com/projects/pov-ray "Coverity: Static Code Analysis")
-[![Maintenance Status](https://img.shields.io/maintenance/yes/2017.svg)](README.md "Last edited 2017-08-18")
+[![Maintenance Status](https://img.shields.io/maintenance/yes/2018.svg)](README.md "Last edited 2018-05-22")
 
 - [License](#license)
 - [Forums](#forums)

appveyor.yml

@@ -80,7 +80,7 @@ for:
       $env:pov_release_type = ($env:pov_build_type).ToLower() + ' release'
       $env:pov_build_title = $env:pov_build_type + ' build'
       $env:pov_build_message += '**Note:** This is a binary-only ' + $env:pov_release_type + '; to install, copy the '
-      $env:pov_build_message += 'binary into an existing POV-Ray 3.7 installation. (Make sure to backup the original '
+      $env:pov_build_message += 'binary into an existing POV-Ray v3.7 installation. (Make sure to backup the original '
       $env:pov_build_message += 'binary first.)'
       $env:pov_build_message += "`n`n"
       $env:pov_build_message += 'These binaries require Windows Vista or higher, due to limitations of our automated '

changes.txt

@@ -37,13 +37,6 @@ This version is still under active development, and not finalized yet.
 NOTE: This release cycle has been redesignated v3.8.0. There will not be a
 v3.7.1 release proper.
 
-Performance Improvements
-------------------------
-
-  - Significantly improved parsing speed of skipped conditional blocks (e.g. in
-    `#if(false) ... #end`), especially for blocks containing few directives
-    (stuff that begins with `#`).
-
 Changed Behaviour
 -----------------
 
@@ -61,6 +54,22 @@ Changed Behaviour
   - Token counting in conditional blocks (e.g. in `#if ... #end`) has changed.
     Whenever such a block is skipped, the token count is now incremented only
     by directives (stuff that begins with `#`).
+  - UV mapping of cylinder, cone and lemon primitives has been disabled again
+    for now, due to their orientation being poorly defined.
+
+New Features
+------------
+
+  - The `ovus` primitive has been extended in multiple ways. See the
+    documentation (currently being maintained on <http://wiki.povray.org>) for
+    details.
+
+Performance Improvements
+------------------------
+
+  - Significantly improved parsing speed of skipped conditional blocks (e.g. in
+    `#if(false) ... #end`), especially for blocks containing few directives
+    (stuff that begins with `#`).
 
 Fixed or Mitigated Bugs
 -----------------------
@@ -85,27 +94,53 @@ Reported via the Newsgroups:
     an orthographic camera.
   - <[email protected]>
     (2018-01-05, povray.beta-test, "3.8.0 block pattern, density list parsing issue.")
+  - <[email protected]>
+    (2018-08-27, povray.advanced-users, "Re: It gets even weirder.")
+    Trying to `#declare Foo[A][B]=...` with `Foo` being an array of arrays and
+    `Foo[A]` not yet initialized causes a hard crash instead of a parse error.
 
 Miscellaneous:
 
   - Fix `interior_texture` for text objects (as mentioned in GitHub issue #65)
   - Eliminated use of deprecated C++ `register` keyword (except in 3rd party
     libraries bundled with the POV-Ray source code).
+  - Fix long-standing bug in Julia fractal primitive using hypercomplex numbers.
+
+Development Related
+-------------------
+
+  - When compiled in debug mode, a new directive `#breakpoint` is now available,
+    intended for triggering an unconditional breakpoint from the scene file, or
+    priming a conditional breakpoint. See `Parser::Parse_Breakpoint()` in
+    `source/parser/parser_tokenizer.cpp` for more details.
+  - When compiled in debug mode, POV-Ray for Windows will now make do with
+    the release version of the editor DLLs if it can't find the debug version.
+  - A new version of the Git pre-commit hook is available; please, copy
+    `pre-commit` from `tools/git/hooks/` to `.git/hooks/` in your local
+    repository.
+  - To simplify version number housekeeping, the file `unix/VERSION` is now
+    created on the fly by the `unix/prebuild.sh` script, and has been dropped
+    from the repository. To retrieve version information from the source
+    package, use one of the new `get-source-version.*` scripts provided in
+    `tools/unix/` and `tools/windows/`, respectively.
+  - To simplify creating reproducible builds, the Unix build process has been
+    amended to compile and link source files in a well-defined order.
 
 Other Noteworthy
 ----------------
 
+  - During alpha development phase, POV-Ray v3.8.0-alpha for Windows will
+    piggypack on an existing v3.7 installation to allow for raw binary
+    distribution.
   - The source code now requires a C++11-compliant compiler.
   - The Unix build process now officially requires Autoconf 2.68 or later.
   - Added `--generation` command-line switch to POV-Ray for Unix, which will
     cause POV-Ray to print its abbreviated version number to standard output.
-  - To simplify version number housekeeping, the file `unix/VERSION` is now
-    created on the fly by the `unix/prebuild.sh` script, and has been dropped
-    from the repository. To retrieve version information from the source
-    package, use one of the new `get-source-version.*` scripts provided in
-    `tools/unix/` and `tools/windows/`, respectively.
   - The `unix/prebuild.sh` script can now be run from the main directory; it is
     no longer necessary to change to the unix directory first.
+  - The `./configure` script can now be run without the `COMPILED_BY=...`
+    option. In this case it defaults to `$USER <no contact address>`, where
+    `$USER` is your login name.
 
 
 Changes between 3.7.1-beta.9 and 3.7.1-rc.1

revision.txt

@@ -35,6 +35,75 @@ Notes:
 POV-Ray v3.8.0-???
 ------------------------------------------------------------------------------
 
+Commit c42e14e7 on 2018-08-27 by Christoph Lipka
+
+    Fix hard crash in `#declare Foo[A][B]=...` if `Foo` is an array of
+    arrays and `Foo[A]` is uninitialized.
+
+Commit 669144e1 on 2018-06-17 by Christoph Lipka
+
+    Fix bug in legacy `version` setting.
+
+Commit ecad9eb1 on 2018-05-27 by Grimbert Jérôme
+
+    Correct (historical) typo for Julia fractal with hypercomplex (#359)
+
+    a small typo, a huge impact on rendered fractal (where .y component was
+    used also as .z, ignoring the provided .z )
+
+Commit 851a509b on 2018-05-22 by Christoph Lipka
+
+    Merge remote-tracking branch 'origin/master'
+
+Commit d825eccf on 2018-05-22 by Christoph Lipka
+
+    Update maintenance status in README.md
+
+Commit e561dfb2 on 2018-05-22 by Christoph Lipka
+
+    Fix another build error on Windows.
+
+Commit cb744d84 on 2018-05-22 by Christoph Lipka
+
+    Check in a file that accidently didn't make it into ef3c54f8.
+
+Commit d6cee867 on 2018-05-21 by Christoph Lipka
+
+    [ci skip] Bring unit test project back to life.
+
+Commit ef3c54f8 on 2018-05-04 by Christoph Lipka
+
+    Eliminate use of `POV_LONG` in the role as 64-bit file offset, and
+    redirect references to `lseek64` via an obvious macro.
+
+Commit 8ef36699 on 2018-05-04 by Christoph Lipka
+
+    Move parser code into dedicated namespace.
+
+Commit 06a120de on 2018-05-02 by Alec Perkins
+
+    Fix typo in README.md (#356)
+
+Commit 576077ed on 2018-05-01 by Christoph Lipka
+
+    [ci skip] Some source documentation work.
+
+Commit bf0e4bf8 on 2018-04-08 by Christoph Lipka
+
+    Some updates to the coding styleguide.
+
+Commit a1ae5d69 on 2018-04-08 by Christoph Lipka
+
+    Work around thread_local-related compiler bug on Mac OS X.
+
+Commit f4ca05e0 on 2018-04-07 by Christoph Lipka
+
+    Eliminate build error in photons code.
+
+Commit 1c131b77 on 2018-04-07 by Christoph Lipka
+
+    Update revision.txt.
+
 Commit d8b8ecfe on 2018-04-07 by Christoph Lipka
 
     Fold v3.8.0 branch back into master branch for now.
@@ -932,7 +1001,7 @@ Commit 481db071 on 2017-01-09 by Christoph Lipka
 
     - Beta now _does_ use the "v3.7-beta" registry key instead of "v3.7".
     - Beta now only copies v3.6 registry data if no existing v3.7 proper
-    installation is found.
+      installation is found.
 
 Commit b6532d07 on 2017-01-09 by Christoph Lipka
 

source-doc/devutils.md

@@ -19,6 +19,11 @@ Git Utilities
         The newly generated `revision.txt` is _not_ intended to be committed as-is, but rather merged with the
         previous version manually.
 
+  - `git update-index --skip-workspace FILENAME`: Use this git command for any file that you have to
+    change in your workspace but don't want to include in any commits nor have it overwritten
+    during a reset (e.g. `source/base/build.h`, which must be edited in a Windows build environment
+    to placate the `BUILT_BY` mechanism).
+
 
 Visual Studio 2010 Utilities
 ============================

source/backend/configbackend.h

@@ -10,7 +10,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.8.
-/// Copyright 1991-2017 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2018 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -77,19 +77,17 @@
 #endif
 
 /// @def POV_THREAD_STACK_SIZE
-///     Internally defaulted thread stack size which the user can override.
-///
-/// @note
-///     The defaulted minimum is 2MB, but later defaulted to 4MB for unix due user regression.
+/// Default thread stack size.
 ///
 #ifndef POV_THREAD_STACK_SIZE
-    #define POV_THREAD_STACK_SIZE (1024 * 1024 * 2)
-#else
-    #if POV_THREAD_STACK_SIZE < (1024 * 64)
-        #error "POV_THREAD_STACK_SIZE set less than 65KB or not a byte count."
-    #endif
+    #define POV_THREAD_STACK_SIZE (2 * 1024 * 1024) // 2 MiB
 #endif
 
+static_assert(
+    POV_THREAD_STACK_SIZE >= 1024 * 1024,
+    "Unreasonably small thread stack size. Proceed at your own risk."
+);
+
 /// @def POV_CONVERT_TEXT_TO_UCS2
 /// Convert text from system-specific format to UCS2.
 ///

source/base/build.h

@@ -13,7 +13,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.8.
-/// Copyright 1991-2017 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2018 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -55,20 +55,78 @@
 ///
 /// @{
 
-// Placeholders for macros injected during automated builds - do not remove or change!
-//{POV_AUTOBUILD_A}
-//{POV_AUTOBUILD_B}
-//{POV_AUTOBUILD_C}
-//{POV_AUTOBUILD_1}
-//{POV_AUTOBUILD_2}
-//{POV_AUTOBUILD_3}
+/// @def POV_BUILD_INFO
+/// Additional version information pertaining to the build.
+///
+/// This optional macro should concisely identify the target runtime environment
+/// as well as the build environment used. For instance, POV-Ray for Windows,
+/// 32-bit binary with SSE2 enabled, built with Visual Studio 2015, might be
+/// identified as `msvc14.sse2.win32`.
+///
+/// @note
+///     If defined, this macro must evaluate to an ASCII string containing only
+///     alphanumeric characters or dots.
+///
+/// The content of this macro will be included in the binary's version string,
+/// separated from the source code version by a `+` character.
+///
+/// The intent is to be able to distinguish binaries generated from the same
+/// source code version but for different target platforms or using different
+/// build environments.
+///
+#if defined(DOXYGEN) && !defined(POV_BUILD_INFO)
+    // Work around doxygen being unable to document undefined macros.
+    #define POV_BUILD_INFO (undefined)
+    #undef POV_BUILD_INFO
+#endif
+
+/// @def POV_RAY_BUILD_ID
+/// Unique build identifier string.
+///
+/// This optional macro should be set to a different string each time the build
+/// process is run, for example by setting it to a timestamp or the value of a
+/// counter automatically incremented before each build.
+///
+/// @note
+///     If defined, this macro must evaluate to an ASCII string containing only
+///     alphanumeric characters or dots.
+///
+/// The content of this macro will effectively be appended to the
+/// @ref POV_BUILD_INFO, separated by a `.` character.
+///
+/// The intent is to be able to distinguish binaries generated from the same
+/// source code version for different target platforms and using similar build
+/// environments, but with potential minute differences that may or may not
+/// cause differences in the binaries.
+///
+/// @note
+///     This macro should never be defined in any source code, but rather
+///     injected via other means as part of the build process, e.g. via a
+///     compiler option (`-DPOV_RAY_BUILD_ID=...` in gcc).
+///
+#if defined(DOXYGEN) && !defined(POV_RAY_BUILD_ID)
+    // Work around doxygen being unable to document undefined macros.
+    #define POV_RAY_BUILD_ID (undefined)
+    #undef POV_RAY_BUILD_ID
+#endif
 
 /// @def BUILT_BY
 /// Specifies the person or organization responsible for this build.
-/// @attention Please set this to your real name, and/or include a working email or website address to contact you.
+///
+/// @attention
+///     Please set this to your real name, and/or include a working email or
+///     website address to contact you.
+///
+/// @note
+///     It is recommended to avoid editing this macro in the source code,
+///     and instead inject the macro via other means. If this is not feasible
+///     and you are working in a git workspace, it is recommended to run
+///     `git update-index --skip-worktree source/base/build.h` to avoid
+///     undesired interference between the repository and your local changes.
+///
 #ifndef BUILT_BY
-#define BUILT_BY "YOUR NAME (YOUR EMAIL)"
-#error "Please fill in BUILT_BY, then remove this line"
+    #define BUILT_BY "YOUR NAME (YOUR EMAIL)"
+    #error "Please fill in BUILT_BY, then remove this line"
 #endif
 
 /// @}

source/base/colour.cpp

@@ -8,7 +8,7 @@
 /// @parblock
 ///
 /// Persistence of Vision Ray Tracer ('POV-Ray') version 3.8.
-/// Copyright 1991-2017 Persistence of Vision Raytracer Pty. Ltd.
+/// Copyright 1991-2018 Persistence of Vision Raytracer Pty. Ltd.
 ///
 /// POV-Ray is free software: you can redistribute it and/or modify
 /// it under the terms of the GNU Affero General Public License as
@@ -45,17 +45,20 @@ namespace pov_base
 #if (NUM_COLOUR_CHANNELS == 3)
 
     // Approximate dominant wavelengths of primary hues.
-    // Source: 3D Computer Graphics by John Vince (Addison Wesely)
+    // Source: 3D Computer Graphics by John Vince (Addison Wesley)
     // These are user-adjustable with the irid_wavelength keyword.
     // Red = 700 nm  Grn = 520 nm Blu = 480 nm
     // Divided by 1000 gives: rwl = 0.70;  gwl = 0.52;  bwl = 0.48;
-    template<> const MathColour MathColour::mkDefaultWavelengths = MathColour(RGBColour(0.70, 0.52, 0.48));
-    template<> const PreciseMathColour PreciseMathColour::mkDefaultWavelengths = PreciseMathColour(PreciseRGBColour(0.70, 0.52, 0.48));
+    template<typename T>
+    const GenericColour<T> GenericColour<T>::mkDefaultWavelengths = GenericColour<T>(GenericRGBColour<T>(0.70, 0.52, 0.48));
 
 #else
 
     #error "TODO!"
 
 #endif
 
+template class GenericColour<ColourChannel>;
+template class GenericColour<PreciseColourChannel>;
+
 }