php_completer.py

# Copyright (C) 2018 ycmd contributors
#
# This file is part of ycmd.
#
# ycmd is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# ycmd 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with ycmd.  If not, see <http://www.gnu.org/licenses/>.

from __future__ import unicode_literals
from __future__ import print_function
from __future__ import division
from __future__ import absolute_import
# Not installing aliases from python-future; it's unreliable and slow.
from builtins import *  # noqa

from ycmd.completers.language_server import (
  simple_language_server_completer as slsc )
from ycmd import responses, utils
from ycmd.utils import LOGGER

import os

PATH_TO_SERVER = os.path.abspath(
  os.path.join(
    os.path.dirname( __file__ ),
    '..',
    '..',
    '..',
    'third_party',
    'php-language-server-runtime',
    'vendor',
    'bin',
    'php-language-server.php' ) )


PATH_TO_PHP = utils.PathToFirstExistingExecutable( [ 'php' ] )


def ShouldEnablePHPCompleter():
  if not os.path.exists( PATH_TO_SERVER ):
    LOGGER.info( "Not using PHP completer: not installed" )
    return False

  if not PATH_TO_PHP:
    LOGGER.warn( "Unable to start PHP completer: can't find PHP" )
    return False

  LOGGER.info( "PHP completer is ready to use" )
  return True


class PHPCompleter( slsc.SimpleLSPCompleter ):
  def __init__( self, user_options ):
    super( PHPCompleter, self ).__init__( user_options )


  def GetServerName( self ):
    return 'php-language-server'


  def GetCommandLine( self ):
    return [ PATH_TO_PHP, PATH_TO_SERVER ]


  def SupportedFiletypes( self ):
    return [ 'php' ]


  def ConvertNotificationToMessage( self, request_data, notification ):
    # Do the normal
    message = super( PHPCompleter, self ).ConvertNotificationToMessage(
      request_data,
      notification )

    if message is not None:
      return message

    # The server returns parsing status as messages, so let's show the user.
    if notification[ 'method' ] == 'window/logMessage':
      return responses.BuildDisplayMessageResponse(
        notification[ 'params' ][ 'message' ] )