planarity: follow upstream layout, add LICENSE.TXT

Author: alejo7797

MANIFEST.in

@@ -1,4 +1,4 @@
-include planarity_src/c/**/*.h
+recursive-include planarity_src/c *.h
 include planarity_src/planarity.pyx
-include planarmap_src/src/*.h
+recursive-include planarmap_src/src *.h
 include planarmap_src/planarmap.pyx

planarity_src/LICENSE.TXT

@@ -0,0 +1,48 @@
+The Edge Addition Planarity Suite
+Copyright (c) 1997-2025, John M. Boyer
+All rights reserved. Includes a reference implementation of the following:
+
+* John M. Boyer. "Subgraph Homeomorphism via the Edge Addition Planarity Algorithm".
+  Journal of Graph Algorithms and Applications, Vol. 16, no. 2, pp. 381-410, 2012.
+  http://dx.doi.org/10.7155/jgaa.00268
+
+* John M. Boyer. "A New Method for Efficiently Generating Planar Graph
+  Visibility Representations". In P. Eades and P. Healy, editors,
+  Proceedings of the 13th International Conference on Graph Drawing 2005,
+  Lecture Notes Comput. Sci., Volume 3843, pp. 508-511, Springer-Verlag, 2006.
+  http://dx.doi.org/10.1007/11618058_47
+
+* John M. Boyer and Wendy J. Myrvold. "On the Cutting Edge: Simplified O(n)
+  Planarity by Edge Addition". Journal of Graph Algorithms and Applications,
+  Vol. 8, No. 3, pp. 241-273, 2004.
+  http://dx.doi.org/10.7155/jgaa.00091
+
+* John M. Boyer. "Simplified O(n) Algorithms for Planar Graph Embedding,
+  Kuratowski Subgraph Isolation, and Related Problems". Ph.D. Dissertation,
+  University of Victoria, 2001.
+  https://dspace.library.uvic.ca/handle/1828/9918
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of The Edge Addition Planarity Suite nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, 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.

planarity_src/c/graph.h

@@ -1,140 +1,25 @@
-#ifndef GRAPH_H
-#define GRAPH_H
+#ifndef HELPERSTUB_GRAPH_H
+#define HELPERSTUB_GRAPH_H
 
 /*
 Copyright (c) 1997-2025, John M. Boyer
 All rights reserved.
 See the LICENSE.TXT file for licensing information.
 */
 
+// NOTE: This helper stub has been added for backwards compatibility to
+// support downstream consumers who expect graph.h to be at the
+// root of the installed planarity headers directory. Future downstream
+// consumers are advised to include the graphLib.h helper stub instead
+// because it offers access to all features in the graph library of
+// the planarity project.
+
 #ifdef __cplusplus
 extern "C"
 {
 #endif
 
-#include "graphStructures.h"
-
-#include "io/g6-read-iterator.h"
-#include "io/g6-write-iterator.h"
-#include "io/strbuf.h"
-#include "io/strOrFile.h"
-
-#include "extensionSystem/graphExtensions.h"
-
-    ///////////////////////////////////////////////////////////////////////////////
-    // Definitions for higher-order operations at the vertex, edge and graph levels
-    ///////////////////////////////////////////////////////////////////////////////
-
-    graphP gp_New(void);
-
-    int gp_InitGraph(graphP theGraph, int N);
-    void gp_ReinitializeGraph(graphP theGraph);
-    int gp_CopyAdjacencyLists(graphP dstGraph, graphP srcGraph);
-    int gp_CopyGraph(graphP dstGraph, graphP srcGraph);
-    graphP gp_DupGraph(graphP theGraph);
-
-    int gp_CreateRandomGraph(graphP theGraph);
-    int gp_CreateRandomGraphEx(graphP theGraph, int numEdges);
-
-    void gp_Free(graphP *pGraph);
-
-    int gp_Read(graphP theGraph, char const *FileName);
-    int gp_ReadFromString(graphP theGraph, char *inputStr);
-
-#define WRITE_ADJLIST 1
-#define WRITE_ADJMATRIX 2
-#define WRITE_DEBUGINFO 3
-#define WRITE_G6 4
-
-    int gp_Write(graphP theGraph, char const *FileName, int Mode);
-    int gp_WriteToString(graphP theGraph, char **pOutputStr, int Mode);
-
-    int gp_IsNeighbor(graphP theGraph, int u, int v);
-    int gp_GetNeighborEdgeRecord(graphP theGraph, int u, int v);
-    int gp_GetVertexDegree(graphP theGraph, int v);
-    int gp_GetVertexInDegree(graphP theGraph, int v);
-    int gp_GetVertexOutDegree(graphP theGraph, int v);
-
-    int gp_GetArcCapacity(graphP theGraph);
-    int gp_EnsureArcCapacity(graphP theGraph, int requiredArcCapacity);
-
-    int gp_AddEdge(graphP theGraph, int u, int ulink, int v, int vlink);
-    int gp_DynamicAddEdge(graphP theGraph, int u, int ulink, int v, int vlink);
-    int gp_InsertEdge(graphP theGraph, int u, int e_u, int e_ulink,
-                      int v, int e_v, int e_vlink);
-
-    void gp_HideEdge(graphP theGraph, int e);
-    void gp_RestoreEdge(graphP theGraph, int e);
-    int gp_HideVertex(graphP theGraph, int vertex);
-    int gp_RestoreVertex(graphP theGraph);
-    int gp_DeleteEdge(graphP theGraph, int e, int nextLink);
-
-    int gp_ContractEdge(graphP theGraph, int e);
-    int gp_IdentifyVertices(graphP theGraph, int u, int v, int eBefore);
-    int gp_RestoreVertices(graphP theGraph);
-
-    int gp_CreateDFSTree(graphP theGraph);
-    int gp_SortVertices(graphP theGraph);
-    int gp_LowpointAndLeastAncestor(graphP theGraph);
-    int gp_LeastAncestor(graphP theGraph);
-    int gp_PreprocessForEmbedding(graphP theGraph);
-
-    int gp_Embed(graphP theGraph, int embedFlags);
-    int gp_TestEmbedResultIntegrity(graphP theGraph, graphP origGraph, int embedResult);
-
-    /* Possible Flags for gp_Embed.  The planar and outerplanar settings are supported
-        natively.  The rest require extension modules. */
-
-#define EMBEDFLAGS_PLANAR 1
-#define EMBEDFLAGS_OUTERPLANAR 2
-
-#define EMBEDFLAGS_DRAWPLANAR (4 | EMBEDFLAGS_PLANAR)
-
-#define EMBEDFLAGS_SEARCHFORK23 (16 | EMBEDFLAGS_OUTERPLANAR)
-#define EMBEDFLAGS_SEARCHFORK4 (32 | EMBEDFLAGS_OUTERPLANAR)
-#define EMBEDFLAGS_SEARCHFORK33 (64 | EMBEDFLAGS_PLANAR)
-
-#define EMBEDFLAGS_SEARCHFORK5 (128 | EMBEDFLAGS_PLANAR)
-
-#define EMBEDFLAGS_MAXIMALPLANARSUBGRAPH 256
-#define EMBEDFLAGS_PROJECTIVEPLANAR 512
-#define EMBEDFLAGS_TOROIDAL 1024
-
-/* If LOGGING is defined, then write to the log, otherwise no-op
-    By default, neither release nor DEBUG builds including LOGGING.
-    Logging is useful for seeing details of how various algorithms
-    handle a particular graph. */
-
-// #define LOGGING
-#ifdef LOGGING
-
-#define gp_LogLine _LogLine
-#define gp_Log _Log
-
-    void _LogLine(const char *Line);
-    void _Log(const char *Line);
-
-#define gp_MakeLogStr1 _MakeLogStr1
-#define gp_MakeLogStr2 _MakeLogStr2
-#define gp_MakeLogStr3 _MakeLogStr3
-#define gp_MakeLogStr4 _MakeLogStr4
-#define gp_MakeLogStr5 _MakeLogStr5
-
-    char *_MakeLogStr1(char *format, int);
-    char *_MakeLogStr2(char *format, int, int);
-    char *_MakeLogStr3(char *format, int, int, int);
-    char *_MakeLogStr4(char *format, int, int, int, int);
-    char *_MakeLogStr5(char *format, int, int, int, int, int);
-
-#else
-#define gp_LogLine(Line)
-#define gp_Log(Line)
-#define gp_MakeLogStr1(format, one)
-#define gp_MakeLogStr2(format, one, two)
-#define gp_MakeLogStr3(format, one, two, three)
-#define gp_MakeLogStr4(format, one, two, three, four)
-#define gp_MakeLogStr5(format, one, two, three, four, five)
-#endif
+#include "c/graphLib/graph.h"
 
 #ifdef __cplusplus
 }

planarity_src/c/graphLib.h

@@ -1,56 +1,22 @@
-#ifndef GRAPHLIB_H
-#define GRAPHLIB_H
+#ifndef HELPERSTUB_GRAPHLIB_H
+#define HELPERSTUB_GRAPHLIB_H
 
 /*
 Copyright (c) 1997-2025, John M. Boyer
 All rights reserved.
 See the LICENSE.TXT file for licensing information.
 */
 
+// NOTE: This helper stub has been added to make it easier for downstream
+// consumers to obtain access to all features in the graph library of
+// the planarity project.
+
 #ifdef __cplusplus
 extern "C"
 {
 #endif
 
-#include <string.h>
-#include <stdlib.h>
-#include <time.h>
-#include <ctype.h>
-
-#include "graph.h"
-
-#include "lowLevelUtils/platformTime.h"
-
-#include "homeomorphSearch/graphK23Search.h"
-#include "homeomorphSearch/graphK33Search.h"
-#include "homeomorphSearch/graphK4Search.h"
-#include "planarityRelated/graphDrawPlanar.h"
-
-    // This is the main location for the project and shared library version numbering.
-    // Changes here must be mirrored in configure.ac
-    //
-    // The overall project version numbering format is major.minor.maintenance.tweak
-    // Major is for an overhaul (e.g. many features, data structure change, change of backward compatibility)
-    // Minor is for feature addition (e.g. a new algorithm implementation added, new interface)
-    // Maintenance is for functional revision (e.g. bug fix to existing algorithm implementation)
-    // Tweak is for a non-functional revision (e.g. change of build scripts or testing code, user-facing string changes)
-
-#define GP_PROJECTVERSION_MAJOR 4
-#define GP_PROJECTVERSION_MINOR 0
-#define GP_PROJECTVERSION_MAINT 1
-#define GP_PROJECTVERSION_TWEAK 0
-
-    char *gp_GetProjectVersionFull(void);
-
-// Any change to the project version numbers should also affect the
-// shared library version numbers below.
-//
-// See configure.ac for how to update these version numbers
-#define GP_LIBPLANARITYVERSION_CURRENT 3
-#define GP_LIBPLANARITYVERSION_REVISION 0
-#define GP_LIBPLANARITYVERSION_AGE 1
-
-    char *gp_GetLibPlanarityVersionFull(void);
+#include "c/graphLib/graphLib.h"
 
 #ifdef __cplusplus
 }