From 53b06d1a521e7b850a4b969c64beb1d24e6ac0ea Mon Sep 17 00:00:00 2001
From: Julius Seporaitis <julius@seporaitis.net>
Date: Sun, 25 Mar 2012 09:49:52 -0700
Subject: [PATCH] Project symbol import from 'ctags'

Summary:
I noticed that documentation said it is possible to have 'ctags' symbol import, so I hacked a quick version. I tested it on Python based project and successfuly imported symbols.

It is limited to classes right now, as the importer script complained about not-unique method names (there are a lot of 'get' & 'post' methods accross classes in my project).

If you would have any feedback about this, I would definetly try to wrap it up for possibly merging into main repository.

Test Plan:
Required 'ctags' tool (ctags.sourceforge.net/) Tested to work with version 5.8+ and didn't work with 3.x.

1. `find . -type f '*.py' | ./generate_ctags_symbols.php > /tmp/symbols`
2. `./import_project_symbols.php` < /tmp/symbols

Reviewers: epriestley, btrahan

Reviewed By: epriestley

CC: seporaitis, aran, epriestley

Maniphest Tasks: T1034

Differential Revision: https://secure.phabricator.com/D1995
---
 scripts/symbols/generate_ctags_symbols.php   | 132 +++++++++++++++++++
 src/docs/userguide/diffusion_symbols.diviner |   6 +
 2 files changed, 138 insertions(+)
 create mode 100755 scripts/symbols/generate_ctags_symbols.php

diff --git a/scripts/symbols/generate_ctags_symbols.php b/scripts/symbols/generate_ctags_symbols.php
new file mode 100755
index 0000000000..4133c13fc8
--- /dev/null
+++ b/scripts/symbols/generate_ctags_symbols.php
@@ -0,0 +1,132 @@
+#!/usr/bin/env php
+<?php
+
+/*
+ * Copyright 2012 Facebook, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+$root = dirname(dirname(dirname(__FILE__)));
+require_once $root.'/scripts/__init_script__.php';
+
+phutil_require_module('phutil', 'console');
+
+if (ctags_check_executable() == false) {
+  echo phutil_console_format(
+    "Could not find Exuberant ctags. Make sure it is installed and\n".
+    "available in executable path.\n\n".
+    "Exuberant ctags project page: http://ctags.sourceforge.net/\n");
+  exit(1);
+}
+
+if ($argc !== 1 || posix_isatty(STDIN)) {
+  echo phutil_console_format(
+    "usage: find . -type f -name '*.py' | ./generate_ctags_symbols.php\n");
+  exit(1);
+}
+
+$input = file_get_contents('php://stdin');
+$input = trim($input);
+$input = explode("\n", $input);
+
+$data = array();
+$futures = array();
+
+foreach ($input as $file) {
+  $file = Filesystem::readablePath($file);
+  $futures[$file] = ctags_get_parser_future($file);
+}
+
+foreach (Futures($futures)->limit(8) as $file => $future) {
+  $tags = $future->resolve();
+  $tags = explode("\n", $tags[1]);
+
+  foreach ($tags as $tag) {
+    $parts = explode(";", $tag);
+    // skip lines that we can not parse
+    if (count($parts) < 2) {
+      continue;
+    }
+
+    // split ctags information
+    $tag_info = explode("\t", $parts[0]);
+    // split exuberant ctags "extension fields" (additional information)
+    $parts[1] = trim($parts[1], "\t \"");
+    $extension_fields = explode("\t", $parts[1]);
+
+    // skip lines that we can not parse
+    if (count($tag_info) < 3 || count($extension_fields) < 2) {
+      continue;
+    }
+
+    list($token, $file_path, $line_num) = $tag_info;
+    list($type, $language) = $extension_fields;
+
+    // strip "language:"
+    $language = substr($language, 9);
+
+    // To keep consistent with "Separate with commas, for example: php, py"
+    // in Arcanist Project edit form.
+    $language = str_ireplace("python", "py", $language);
+
+    // also, "normalize" c++ and c#
+    $language = str_ireplace("c++", "cpp", $language);
+    $language = str_ireplace("c#", "csharp", $language);
+
+    switch ($type) {
+    case 'class':
+      print_symbol($file_path, $line_num, 'class', $token, $language);
+      break;
+    case 'function':
+      print_symbol($file_path, $line_num, 'function', $token, $language);
+      break;
+    default:
+    }
+  }
+}
+
+function ctags_get_parser_future($file_path) {
+  $future = new ExecFuture('ctags -n --fields=Kl -o - %s',
+                           $file_path);
+  return $future;
+}
+
+function ctags_check_executable() {
+  $future = new ExecFuture('ctags --version');
+  $result = $future->resolve();
+
+  if (empty($result[1])) {
+    return false;
+  }
+
+  return true;
+}
+
+function print_symbol($file, $line_num, $type, $token, $language) {
+  // get rid of relative path
+  $file = explode('/', $file);
+  if ($file[0] == '.' || $file[0] == "..") {
+    array_shift($file);
+  }
+  $file = '/' . implode('/', $file);
+
+  $parts = array(
+    $token,
+    $type,
+    strtolower($language),
+    $line_num,
+    $file,
+  );
+  echo implode(' ', $parts)."\n";
+}
diff --git a/src/docs/userguide/diffusion_symbols.diviner b/src/docs/userguide/diffusion_symbols.diviner
index d17f95560d..f0f0131960 100644
--- a/src/docs/userguide/diffusion_symbols.diviner
+++ b/src/docs/userguide/diffusion_symbols.diviner
@@ -27,6 +27,12 @@ Phabricator includes a script which can identify symbols in PHP projects:
 
   ./scripts/symbols/generate_php_symbols.php
 
+Phabricator also includes a script which can identify symbols in any
+programming language that has classes and/or functions, and is supported by
+Exuberant Ctags (http://ctags.sourceforge.net):
+
+  ./scripts/symbols/generate_ctags_symbols.php
+
 If you want to identify symbols from another language, you need to write a
 script which can export them (for example, maybe by parsing a ##ctags## file).