pack.h

Go to the documentation of this file.

 
/*************************************************************************
 * Copyright (c) 2011 AT&T Intellectual Property 
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * https://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors: Details at https://graphviz.org
 *************************************************************************/
 
#pragma once
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "types.h"
 
/* Type indicating granularity and method 
 *  l_undef    - unspecified
 *  l_node     - polyomino using nodes and edges
 *  l_clust    - polyomino using nodes and edges and top-level clusters
 *               (assumes ND_clust(n) unused by application)
 *  l_graph    - polyomino using computer graph bounding box
 *  l_array    - array based on graph bounding boxes
 *  l_aspect   - tiling based on graph bounding boxes preserving aspect ratio
 *  l_hull     - polyomino using convex hull (unimplemented)
 *  l_tile     - tiling using graph bounding box (unimplemented)
 *  l_bisect   - alternate bisection using graph bounding box (unimplemented)
 */
    typedef enum { l_undef, l_clust, l_node, l_graph, l_array, l_aspect } pack_mode;
 
#define PK_COL_MAJOR   (1 << 0)
#define PK_USER_VALS   (1 << 1)
#define PK_LEFT_ALIGN  (1 << 2)
#define PK_RIGHT_ALIGN (1 << 3)
#define PK_TOP_ALIGN   (1 << 4)
#define PK_BOT_ALIGN   (1 << 5)
#define PK_INPUT_ORDER (1 << 6)
 
typedef unsigned int packval_t;
 
    typedef struct {
        float aspect;           /* desired aspect ratio */
        int sz;                 /* row/column size size */
        unsigned int margin;    /* margin left around objects, in points */
        bool doSplines; 
        pack_mode mode;         /* granularity and method */
        bool *fixed;            /* fixed[i] == true implies g[i] should not be moved */
        packval_t* vals;        /* for arrays, sort numbers */
        int flags;       
    } pack_info;
 
#ifdef GVDLL
#ifdef GVC_EXPORTS
#define PACK_API __declspec(dllexport)
#else
#define PACK_API __declspec(dllimport)
#endif
#endif
 
#ifndef PACK_API
#define PACK_API /* nothing */
#endif
 
    PACK_API pointf *putRects(size_t ng, boxf *bbs, pack_info *pinfo);
    PACK_API int packRects(size_t ng, boxf* bbs, pack_info* pinfo);
 
    PACK_API pointf *putGraphs(size_t, Agraph_t **, Agraph_t *, pack_info *);
    PACK_API int packGraphs(size_t, Agraph_t **, Agraph_t *, pack_info *);
    PACK_API int packSubgraphs(size_t, Agraph_t **, Agraph_t *, pack_info *);
    PACK_API int pack_graph(size_t ng, Agraph_t **gs, Agraph_t *root, bool *fixed);
 
    PACK_API int shiftGraphs(size_t, Agraph_t **, pointf *, Agraph_t *, bool);
 
    PACK_API pack_mode getPackMode(Agraph_t * g, pack_mode dflt);
    PACK_API int getPack(Agraph_t *, int not_def, int dflt);
    PACK_API pack_mode getPackInfo(Agraph_t * g, pack_mode dflt, int dfltMargin, pack_info*);
    PACK_API pack_mode getPackModeInfo(Agraph_t * g, pack_mode dflt, pack_info*);
    PACK_API pack_mode parsePackModeInfo(const char* p, pack_mode dflt,
                                         pack_info* pinfo);
 
    PACK_API int isConnected(Agraph_t *);
    PACK_API Agraph_t **ccomps(Agraph_t *, size_t *, char *);
    PACK_API Agraph_t **cccomps(Agraph_t *, size_t *, char *);
    PACK_API Agraph_t **pccomps(Agraph_t *, size_t *, char *, bool *);
    PACK_API Agraph_t *mapClust(Agraph_t *);
#undef PACK_API
#ifdef __cplusplus
}
#endif