/********************************************************************************
 * Copyright (c) 2022-2023 STMicroelectronics and others.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the Eclipse
 * Public License v. 2.0 are satisfied: GNU General Public License, version 2
 * with the GNU Classpath Exception which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 ********************************************************************************/
import { GModelElement, GModelElementBuilder } from './gmodel-element';

export const GLayouting = Symbol('GLayouting');

export interface GLayouting {
    layout?: string;
    [GLayouting]: boolean;
}

export function isGLayouting<G extends GModelElement>(element: G): element is G & GLayouting {
    return GLayouting in element && element[GLayouting] === true;
}

export type GLayoutingBuilder = GModelElementBuilder<GModelElement & GLayouting>;

export namespace GLayoutingBuilder {
    export function layout<B extends GLayoutingBuilder>(builder: B, newLayout?: string): B {
        builder['proxy'].layout = newLayout;
        return builder;
    }
}