CGSSpace.h

//
//  CGSSpace.h
//  CGSInternal
//
//  Created by Robert Widmann on 9/14/13.
//  Copyright (c) 2015 CodaFi. All rights reserved.
//  Released under the MIT license.
//

// Modifications Copyright (c) 2015 Aaron Magill
// Released under the MIT license

#ifndef CGS_SPACE_INTERNAL_H
#define CGS_SPACE_INTERNAL_H

#include "CGSConnection.h"
#include "CGSRegion.h"

typedef size_t CGSSpaceID;

/// Representations of the possible types of spaces the system can create.
// typedef enum {
//  /// User-created desktop spaces.
//  CGSSpaceTypeUser    = 0,
//  /// Fullscreen spaces.
//  CGSSpaceTypeFullscreen  = 1,
//  /// System spaces e.g. Dashboard.
//  CGSSpaceTypeSystem    = 2,
// } CGSSpaceType;

typedef enum _CGSSpaceType {
    kCGSSpaceUser,
    kCGSSpaceFullscreen,
    kCGSSpaceSystem,
    kCGSSpaceUnknown,
    kCGSSpaceTiled
} CGSSpaceType;

/// Flags that can be applied to queries for spaces.
typedef enum {
  CGSSpaceIncludesCurrent  = 1 << 0,    // Dock, Notification Center, etc.
  CGSSpaceIncludesOthers   = 1 << 1,    // Expose

  CGSSpaceIncludesUser     = 1 << 2,    // User controlled spaces
  CGSSpaceIncludesOS       = 1 << 3,    // OS X controlled spaces

  CGSSpaceVisible          = 1 << 16,   // ?

  kCGSCurrentSpacesMask    = CGSSpaceIncludesUser | CGSSpaceIncludesCurrent,
  kCGSOtherSpacesMask      = CGSSpaceIncludesUser | CGSSpaceIncludesOthers,
  kCGSAllSpacesMask        = CGSSpaceIncludesUser | CGSSpaceIncludesOthers |  CGSSpaceIncludesCurrent,

  kCGSCurrentOSSpacesMask  = CGSSpaceIncludesOS   | CGSSpaceIncludesCurrent,
  kCGSOtherOSSpacesMask    = CGSSpaceIncludesOS   | CGSSpaceIncludesOthers,
  kCGSAllOSSpacesMask      = CGSSpaceIncludesOS   | CGSSpaceIncludesOthers |  CGSSpaceIncludesCurrent,

  kCGSAllVisibleSpacesMask = CGSSpaceVisible      | kCGSAllSpacesMask,  // ?
} CGSSpaceMask;


#pragma mark - Space Lifecycle


/// Creates a new space with the given options dictionary.
///
/// Valid keys are:
///
///     "type": CFNumberRef
///     "uuid": CFStringRef
CG_EXTERN CGSSpaceID CGSSpaceCreate(CGSConnectionID cid, void *null, CFDictionaryRef options);

/// Removes and destroys the space corresponding to the given space ID.
CG_EXTERN void CGSSpaceDestroy(CGSConnectionID cid, CGSSpaceID sid);


#pragma mark - Configuring Spaces


/// Get and set the human-readable name of a space.
CG_EXTERN CFStringRef CGSSpaceCopyName(CGSConnectionID cid, CGSSpaceID sid);
CG_EXTERN CGError CGSSpaceSetName(CGSConnectionID cid, CGSSpaceID sid, CFStringRef name);

/// Get and set the affine transform of a space.
CG_EXTERN CGAffineTransform CGSSpaceGetTransform(CGSConnectionID cid, CGSSpaceID space);
CG_EXTERN void CGSSpaceSetTransform(CGSConnectionID cid, CGSSpaceID space, CGAffineTransform transform);

/// Gets and sets the region the space occupies.  You are responsible for releasing the region object.
CG_EXTERN void CGSSpaceSetShape(CGSConnectionID cid, CGSSpaceID space, CGSRegionRef shape);
CG_EXTERN CGSRegionRef CGSSpaceCopyShape(CGSConnectionID cid, CGSSpaceID space);



#pragma mark - Space Properties


/// Copies and returns a region the space occupies.  You are responsible for releasing the region object.
CG_EXTERN CGSRegionRef CGSSpaceCopyManagedShape(CGSConnectionID cid, CGSSpaceID sid);

/// Gets the type of a space.
CG_EXTERN CGSSpaceType CGSSpaceGetType(CGSConnectionID cid, CGSSpaceID sid);


#pragma mark - Global Space Properties


/// Gets the ID of the space currently visible to the user.
CG_EXTERN CGSSpaceID CGSGetActiveSpace(CGSConnectionID cid);

/// Returns an array of PIDs of applications that have ownership of a given space.
CG_EXTERN CFArrayRef CGSSpaceCopyOwners(CGSConnectionID cid, CGSSpaceID sid);

/// Returns an array of all space IDs.
CG_EXTERN CFArrayRef CGSCopySpaces(CGSConnectionID cid, CGSSpaceMask mask);

/// Given an array of window numbers, returns the IDs of the spaces those windows lie on.
CG_EXTERN CFArrayRef CGSCopySpacesForWindows(CGSConnectionID cid, CGSSpaceMask mask, CFArrayRef windowIDs);


#pragma mark - Space-Local State


/// Connection-local data in a given space.
CG_EXTERN CFDictionaryRef CGSSpaceCopyValues(CGSConnectionID cid, CGSSpaceID space);
CG_EXTERN CGError CGSSpaceSetValues(CGSConnectionID cid, CGSSpaceID sid, CFDictionaryRef values);
CG_EXTERN CGError CGSSpaceRemoveValuesForKeys(CGSConnectionID cid, CGSSpaceID sid, CFArrayRef values);


#pragma mark - Displaying Spaces


/// Given an array of space IDs, each space is shown to the user.
CG_EXTERN void CGSShowSpaces(CGSConnectionID cid, CFArrayRef spaces);

/// Given an array of space IDs, each space is hidden from the user.
CG_EXTERN void CGSHideSpaces(CGSConnectionID cid, CFArrayRef spaces);

/// Given an array of window numbers and an array of space IDs, adds each window to each space.
CG_EXTERN void CGSAddWindowsToSpaces(CGSConnectionID cid, CFArrayRef windows, CFArrayRef spaces);

/// Given an array of window numbers and an array of space IDs, removes each window from each space.
CG_EXTERN void CGSRemoveWindowsFromSpaces(CGSConnectionID cid, CFArrayRef windows, CFArrayRef spaces);

CG_EXTERN CFStringRef kCGSPackagesMainDisplayIdentifier;

/// Changes the active space for a given display.
CG_EXTERN void CGSManagedDisplaySetCurrentSpace(CGSConnectionID cid, CFStringRef display, CGSSpaceID space);


#pragma mark - Additional Functions from https://gist.github.com/puffnfresh/4053980

CG_EXTERN int CGSSpaceGetAbsoluteLevel(const CGSConnectionID cid, CGSSpaceID space);
CG_EXTERN void CGSSpaceSetAbsoluteLevel(const CGSConnectionID cid, CGSSpaceID space, int level);

CG_EXTERN int CGSSpaceGetCompatID(const CGSConnectionID cid, CGSSpaceID space);
CG_EXTERN void CGSSpaceSetCompatID(const CGSConnectionID cid, CGSSpaceID space, int compatID);

CG_EXTERN void CGSSpaceSetType(const CGSConnectionID cid, CGSSpaceID space, CGSSpaceType type);

CG_EXTERN CFStringRef CGSCopyBestManagedDisplayForRect(const CGSConnectionID cid, CGRect rect);
CG_EXTERN CFStringRef CGSCopyManagedDisplayForSpace(const CGSConnectionID cid, CGSSpaceID space);
CG_EXTERN CFArrayRef CGSCopyManagedDisplaySpaces(const CGSConnectionID cid);

CG_EXTERN bool CGSManagedDisplayIsAnimating(const CGSConnectionID cid, CFStringRef display);
CG_EXTERN void CGSManagedDisplaySetIsAnimating(const CGSConnectionID cid, CFStringRef display, bool isAnimating);

CG_EXTERN int CGSWillSwitchSpaces(const CGSConnectionID cid, CFArrayRef a);

#endif /// CGS_SPACE_INTERNAL_H */