function out = rulerFunctions(func, numargsout, args)

% This function is undocumented and may change in a future release.

%   Copyright 2016-2018 The MathWorks, Inc.

% --- Input parsing and error checking ---

% Parse the function name into pieces.

[axle, ruler, family, prop, mode] = parseFunctionName(func); 

% Count how many arguments were passed into the parent function

nargs = numel(args); 

% Make sure we have 0-2 input arguments to the calling function.

if nargs > 2 

    throwAsCaller(MException(message('MATLAB:narginchk:tooManyInputs')))

end 

% Make sure we have either 0 or 1 output arguments to the calling function.

if numargsout > 1 

    throwAsCaller(MException(message('MATLAB:nargoutchk:tooManyOutputs')));

end 

% Helper function to validate the acceptable types of axes.

% Axes types are listed separately to prevent mixed vectors.

isAxes = @(ax) isa(ax,'matlab.graphics.axis.Axes') || ... 

    isa(ax, 'matlab.graphics.axis.PolarAxes') || ...

    isa(ax, 'matlab.graphics.axis.GeographicAxes') || ...

    isa(ax, 'matlab.ui.control.UIAxes') || ...

    isa(ax, 'matlab.graphics.illustration.ColorBar') || ...

    isa(ax, 'matlab.graphics.chart.Chart');

% Parse the input arguments to look for an Axes.

if nargs > 0 && isscalar(args{1}) && (isgraphics(args{1},'axes') || ... 

        isgraphics(args{1},'polaraxes') || ...

        isgraphics(args{1},'geoaxes') || ...

        isgraphics(args{1},'colorbar'))

    % The first input is a single axes or colorbar.

    ax = handle(args{1});

    args = args(2:end);

    nargs = nargs - 1;

elseif nargs > 0 && ~isempty(args{1}) && isAxes(args{1}) && all(isvalid(args{1}(:))) 

    % The first input is an array of axes, charts, or colorbars.

    ax = args{1}(:);

    args = args(2:end);

    nargs = nargs - 1;

elseif nargs > 0 && isa(args{1},'matlab.graphics.Graphics') 

    if ~isempty(args{1}) && all(isvalid(args{1}(:))) && all(arrayfun(isAxes,args{1}(:)))

        % Mixed list of different types of axes.

        throwAsCaller(MException(message('MATLAB:rulerFunctions:MixedAxesVector')));

    else

        % Empty vector or one of the objects is not an axes or has been deleted.

        throwAsCaller(MException(message('MATLAB:rulerFunctions:InvalidObject')));

    end

elseif nargs == 2 

    % If we have two input arguments and the first input is not a valid

    % graphics object, then the user specified an invalid syntax.

    throwAsCaller(MException(message('MATLAB:rulerFunctions:InvalidAxes')));

else 

    % No axes handle provided, so use the current Axes.

    ax = gca; 

end 

fh = []; 

if isa(ax,'matlab.graphics.chart.Chart') 

    % Subclasses of matlab.graphics.chart.Chart will implement individual

    % ruler functions if they are supported.

    % Error if the function does not exist as a method on the chart.

    if(~isPublicMethod(ax,func))

        throwAsCaller(MException(message('MATLAB:Chart:UnsupportedConvenienceFunction', func, ax(1).Type)));

    end

    % Store a function handle for use later.

    fh = str2func(func);

    ruler = ax;

elseif isa(ax,'matlab.graphics.axis.GeographicAxes') 

    throwAsCaller(MException(message('MATLAB:Chart:UnsupportedConvenienceFunction', func, ax(1).Type)));

elseif isempty(ruler) && all(isprop(ax,prop)) 

    % Limits are set on the Axes directly so that PreSet/PostSet events are

    % triggered, and for compatibility with colorbars.

    ruler = ax; 

elseif all(isprop(ax,ruler))

    % All other properties are set on the Rulers directly.

    ruler = vertcat(ax(:).(ruler));

elseif isa(ax, 'matlab.graphics.illustration.ColorBar')

    % Colorbars support the xlim and ylim commands only for compatibility.

    throwAsCaller(MException(message('MATLAB:rulerFunctions:ColorBar',func)));

elseif isa(ax, 'matlab.ui.control.UIAxes')

    % UIAxes only supports X and Y

    throwAsCaller(MException(message('MATLAB:rulerFunctions:UIAxes',func)));

else

    % The axes specified is not compatible with this function (such as

    % calling xlim on a PolarAxes).

    throwAsCaller(axesTypeMismatch(axle, family));

end 

% Filter out tickformat functions on CategoricalRuler

if strcmp(family,'tickformat') && ... 

        any(isa(ruler,'matlab.graphics.axis.decorator.CategoricalRuler'))

    throwAsCaller(MException(message('MATLAB:rulerFunctions:Categorical',func)));

end 

% --- Get/Set the property based on the inputs ---

% Initialize output variables.

out = cell(0); 

if nargs == 0 

    % If no additional inputs were provided, return the current value of

    % the property.

    if ~isempty(fh)

        % Call the chart specific implementation.

        try

            out{1} = fh(ruler, args{:});

        catch err

            throwAsCaller(err);

        end

    elseif isscalar(ruler)

        out{1} = ruler.(prop);

    else

        out{1} = {ruler(:).(prop)}';

    end

    return

end 

% Grab the value from the remaining input arguments.

val = args{1}; 

% If the property has a mode setting, check if the user is trying to

% change or query the mode.

if ~isempty(mode) && matlab.graphics.internal.isCharOrString(val) 

    switch lower(val)

        case 'mode'

            % The user requested the current property mode

            if ~isempty(fh)

                % Call the chart specific implementation.

                try

                    out{1} = fh(ruler, 'mode');

                catch err

                    throwAsCaller(err);

                end

            elseif isscalar(ruler)

                out{1} = ruler.(mode);

            else

                out{1} = {ruler(:).(mode)}';

            end

            return

        case {'auto','manual'}

            % The user is trying to set the property mode

            if isempty(fh)

                % No output arguments are returned when you set the

                % property mode.

                if numargsout > 0

                    throwAsCaller(MException(message('MATLAB:nargoutchk:tooManyOutputs')));

                end

                % Set the mode

                set(ruler,mode,val);

                % This command notifies the Live Editor of potential changes to the figure.

                matlab.graphics.internal.markFigure(ax);

                return

            end

    end

end 

% Call the chart specific implementation of the ruler function. Use the

% same number of outputs to defer error handling to the method.

if ~isempty(fh) 

    out = cell(1,numargsout);

    try

        if numargsout == 0

            fh(ax,val);

        else

            [out{1:nargout}] = fh(ax,val);

        end

    catch err

        throwAsCaller(err);

    end

    return

end 

% No output arguments are returned when you set the property.

if numargsout > 0 

    throwAsCaller(MException(message('MATLAB:nargoutchk:tooManyOutputs')));

end 

% Try to set the property to the specified value.

try 

    switch family 

        case {'lim','ticks','tickangle'} 

            set(ruler,prop,val); 

        case 'ticklabels'

            matlab.graphics.internal.ruler.setTickLabel(ruler, val);

        case 'tickformat'

            matlab.graphics.internal.ruler.setTickFormat(ruler, val);

    end 

catch err

    % Check for recognized errors and replace them with custom error

    % messages specific to the convenience function.

    err = swapKnownErrorIDs(err, axle, val);

    throwAsCaller(err);

end 

% This command notifies the Live Editor of potential changes to the figure.

matlab.graphics.internal.markFigure(ax); 

end