%%% This file is part of RefactorErl.
%%%
%%% RefactorErl is free software: you can redistribute it and/or modify
%%% it under the terms of the GNU Lesser General Public License as published
%%% by the Free Software Foundation, either version 3 of the License, or
%%% (at your option) any later version.
%%%
%%% RefactorErl is distributed in the hope that it will be useful,
%%% but WITHOUT ANY WARRANTY; without even the implied warranty of
%%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
%%% GNU Lesser General Public License for more details.
%%%
%%% You should have received a copy of the GNU Lesser General Public License
%%% along with RefactorErl.  If not, see <http://plc.inf.elte.hu/erlang/>.
%%%
%%% The Original Code is RefactorErl.
%%%
%%% The Initial Developer of the Original Code is Eötvös Loránd University.
%%% Portions created  by Eötvös Loránd University and ELTE-Soft Ltd.
%%% are Copyright 2007-2025 Eötvös Loránd University, ELTE-Soft Ltd.
%%% and Ericsson Hungary. All Rights Reserved.


%%% ============================================================================
%%% Module information

%%% @doc This module implements the eliminate macro refactoring. This
%%% refactoring can eliminate macros in modules and header files.
%%%
%%% == Parameters ==
%%% <ul>
%%%   <li> The macro to be eliminated
%%%        (see {@link reflib_args:macro/1}).</li>
%%% </ul>
%%%
%%% == Conditions of applicability ==
%%% <ul>
%%%   <li> The given macro is not used </li>
%%% </ul>
%%%
%%% == Implementation status ==
%%% The transformation is working on unused macros.
%%%
%%% @author Robert Molnar <elkor@caesar.elte.hu>

-module(reftr_elim_macro).
-vsn("$Rev$").

-export([prepare/1, error_text/2]).

-include("user.hrl").


%%% ============================================================================
%%% Errors

%% @private

error_text(badarg, [Error]) ->
    ["Used macro: ", ?MISC:format("~p",[Error])].



%%% ============================================================================
%%% Callbacks

prepare(Args) ->
    {nodes,FormNode} = 
        case lists:keyfind(nodes, 1, Args) of
            false ->
                Macro = ?Args:macro(Args),
                {nodes,Macro};
            Found ->
                Found
        end,
    Refs=
        case lists:keyfind(deadcode, 1, Args) of
            false ->
                ?Query:exec(FormNode,[{mref,back}]);
            _ ->
                []
        end,
    
    File=?Query:exec(FormNode,?Form:file()),
    
    if 
        Refs==[] ->
            [fun() -> ?File:del_form(FormNode) end] ++ 
            	[fun(ok) -> ?Transform:touch(File), [] end];
        true ->
            throw(?LocalError(badarg, FormNode))
    end.
