From 92621d6f99fd724ad4d7168d210b79f05de341a9 Mon Sep 17 00:00:00 2001
From: Jim Derry <balthisar@gmail.com>
Date: Thu, 2 Mar 2017 09:32:02 -0500
Subject: [PATCH] MSVC Compatibility   - Changed location of pointer operator
 in declarations.   - Updated `CODESTYLE.md` to reflect this.   - Updated
 `API_AND_NAMESPACE.md` to reflect this.

---
 README/API_AND_NAMESPACE.md | 12 ++++++++++++
 README/CODESTYLE.md         |  3 +++
 include/tidy.h              |  2 +-
 src/tidylib.c               |  2 +-
 4 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/README/API_AND_NAMESPACE.md b/README/API_AND_NAMESPACE.md
index 8c97df1..5acb5b9 100644
--- a/README/API_AND_NAMESPACE.md
+++ b/README/API_AND_NAMESPACE.md
@@ -36,6 +36,18 @@ The `TIDY_EXPORT` call clearly indicates that this function prototype is meant t
 
 Although this makes things obvious from the documentation perspective, the truth is a little murkier. In some environments one might define `TIDY_EXPORT` and `TIDY_CALL` differently in order to control compiler behavior, especially in environments that have special requirements for dynamic libraries. In general, though, you shouldn't have to worry about this.
 
+Note that MSVC has issues with macros inserted before pointer operators, and so the preferred use of pointer operators when documenting with macros is this:
+
+~~~
+const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter )
+~~~
+
+…instead of this:
+
+~~~
+const tidyLocaleMapItem TIDY_CALL *getNextWindowsLanguage( TidyIterator* iter )
+~~~
+
 
 # External types are opaque
 
diff --git a/README/CODESTYLE.md b/README/CODESTYLE.md
index 7161104..04f4c53 100644
--- a/README/CODESTYLE.md
+++ b/README/CODESTYLE.md
@@ -18,6 +18,9 @@ From reading of the Tidy source, some things are self evident... in no particula
  - No C++ single line comments using `//`.
  - The openning `{` is indented on the next newline.
  - While the maximum code line length varies, generally long `if`, `while`, ... statements are wrapped to newlines.
+ - For compatibility with MSVC, pointer operators in declarations must precede any macro documentation, e.g, `const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter )` instead of `const tidyLocaleMapItem TIDY_CALL *getNextWindowsLanguage( TidyIterator* iter )`.
+
+
 
 Look forward to this document being filled out in detail...
 
diff --git a/include/tidy.h b/include/tidy.h
index 1da8906..58a5fef 100644
--- a/include/tidy.h
+++ b/include/tidy.h
@@ -1173,7 +1173,7 @@ TIDY_EXPORT TidyIterator TIDY_CALL getWindowsLanguageList();
  *  Returns the next record of type `localeMapItem` in
  *  Tidy's structure of Windows<->POSIX local mapping.
  */
-TIDY_EXPORT const tidyLocaleMapItem TIDY_CALL *getNextWindowsLanguage( TidyIterator* iter );
+TIDY_EXPORT const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter );
 
 /**
  *  Given a `tidyLocalMapItem`, return the Windows name.
diff --git a/src/tidylib.c b/src/tidylib.c
index af72cdb..f0457a0 100755
--- a/src/tidylib.c
+++ b/src/tidylib.c
@@ -2428,7 +2428,7 @@ TidyIterator TIDY_CALL getWindowsLanguageList()
 //#define tidyOptionToImpl( topt )    ((const TidyOptionImpl*)(topt))
 //#define tidyImplToOption( option )  ((TidyOption)(option))
 
-const tidyLocaleMapItem TIDY_CALL *getNextWindowsLanguage( TidyIterator* iter )
+const tidyLocaleMapItem* TIDY_CALL getNextWindowsLanguage( TidyIterator* iter )
 {
     /* Get a real structure */
     const tidyLocaleMapItemImpl *item = TY_(getNextWindowsLanguage)( iter );