Skip to content
This repository
tree: 9fa72e3b23
Fetching contributors…

Cannot retrieve contributors at this time

file 196 lines (160 sloc) 6.238 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
(*
* Please imagine a long and boring gnu-style copyright notice
* appearing just here.
*)
open Common

(*****************************************************************************)
(* Purpose *)
(*****************************************************************************)

(* A more precise etags/ctags.
*
* Both etags and ctags are working at a lexical level
* and so have lots of false positives for the definitions. For instance
* on PHP, a line containing $idx will be considered as a candidate when
* searching for idx. By using a real parser tagging a file becomes
* trivial and correct (but slower I have to admit).
*
* Note that for OCaml the situation is kinda reversed. 'otags'
* can work only at the AST level, which requires to
* correctly parse the file. Nevertheless many files using camlp4 are
* causing otags to fatal. One option is to help otags by passing it
* the correct -pp flags. Another option is to at least default to
* a lexical-level tag generator which is what I do here.
*
* usage:
* $ stags -lang web -o TAGS *
*)

(*****************************************************************************)
(* Flags *)
(*****************************************************************************)

(* In addition to flags that can be tweaked via -xxx options (cf the
* full list of options in the "the options" section below), this
* program also depends on external files ?
*)
let verbose = ref false

(* action mode *)
let action = ref ""

(* obsolete ? *)
let heavy_tagging = ref false

let lang = ref "php"

let output_file = ref "TAGS"

type format = Vim | Emacs
let format = ref Emacs

(*****************************************************************************)
(* Some debugging functions *)
(*****************************************************************************)

(*****************************************************************************)
(* Helpers *)
(*****************************************************************************)

(*****************************************************************************)
(* Language specific *)
(*****************************************************************************)

let rec defs_of_files_or_dirs lang xs =
  let verbose = !verbose in
  let _heavy_tagging = !heavy_tagging in
  match lang with
  | "php" ->
      Tags_php.php_defs_of_files_or_dirs ~verbose (*~heavy_tagging*) xs
  | "js" ->
      Tags_js.tags_of_files_or_dirs ~verbose xs
  | "ml" ->
      Tags_ml.defs_of_files_or_dirs ~verbose xs

  | "web" ->
      let tag1 = defs_of_files_or_dirs "php" xs in
      let tag2 = defs_of_files_or_dirs "js" xs in
      tag1 ++ tag2

  | _ -> failwith ("language not supported: " ^ lang)
      
(*****************************************************************************)
(* Main action *)
(*****************************************************************************)

let main_action xs =
  Logger.log Config.logger "stags" None;

  (* This can augment the size of the tags file
let xs = List.map relative_to_absolute xs in
*)
  let tags_file =
    (*
* Common.relative_to_absolute "TAGS" in
* let res = Common.y_or_no (spf "writing data in %s" tag_file) in
* if not res
* then failwith "ok I stop";
*)
    !output_file
  in
  let files_and_defs = defs_of_files_or_dirs !lang xs in
  pr2 (spf "Writing data in %s" tags_file);


  (match !format with
  | Emacs -> Tags_file.generate_TAGS_file ~tags_file files_and_defs;
  | Vim -> Tags_file.generate_vi_tags_file ~tags_file files_and_defs;
  );
  ()

(*****************************************************************************)
(* The options *)
(*****************************************************************************)

let all_actions () =
  []

let options () =
  [
    "-lang", Arg.Set_string lang,
    (spf " <str> choose language (default = %s)" !lang);
    "-o", Arg.Set_string output_file,
    " <file> default = TAGS";
    "-vim", Arg.Unit (fun () -> format := Vim),
    " ";
    "-emacs", Arg.Unit (fun () -> format := Emacs),
    " ";
    "-verbose", Arg.Set verbose,
    " ";
    "-heavy_tagging", Arg.Set heavy_tagging,
    " generates some extra tags with semantic prefix: F_, C_, M_";

  ] ++

  Common.options_of_actions action (all_actions()) ++
  Common.cmdline_flags_devel () ++
  Common.cmdline_flags_other () ++
  [
    "-version", Arg.Unit (fun () ->
      pr2 (spf "stags version: %s" Config.version);
      exit 0;
    ), " guess what";
  ]

(*****************************************************************************)
(* Main entry point *)
(*****************************************************************************)

let main () =

  (* Common_extra.set_link();
let argv = Features.Distribution.mpi_adjust_argv Sys.argv in
*)

  let usage_msg =
    "Usage: " ^ basename Sys.argv.(0) ^
      " [options] <file or dir> " ^ "\n" ^ "Options are:"
  in
  (* does side effect on many global flags *)
  let args = Common.parse_options (options()) usage_msg Sys.argv in

  (* must be done after Arg.parse, because Common.profile is set by it *)
  Common.profile_code "Main total" (fun () ->
    
    (match args with
    
    (* --------------------------------------------------------- *)
    (* actions, useful to debug subpart *)
    (* --------------------------------------------------------- *)
    | xs when List.mem !action (Common.action_list (all_actions())) ->
        Common.do_action !action xs (all_actions())

    | _ when not (Common.null_string !action) ->
        failwith ("unrecognized action or wrong params: " ^ !action)

    (* --------------------------------------------------------- *)
    (* main entry *)
    (* --------------------------------------------------------- *)
    | x::xs ->
        main_action (x::xs)

    (* --------------------------------------------------------- *)
    (* empty entry *)
    (* --------------------------------------------------------- *)
    | [] ->
        Common.usage usage_msg (options());
        failwith "too few arguments"
    )
  )

(*****************************************************************************)
let _ =
  Common.main_boilerplate (fun () ->
    main ();
  )
Something went wrong with that request. Please try again.