com.embeddedunveiled.serial.internal.SerialComPortsList Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scm Show documentation
serial communication in java
The newest version!
/*
 * Author : Rishi Gupta
 * 
 * This file is part of 'serial communication manager' library.
 * Copyright (C) <2014-2016>  
 *
 * This 'serial communication manager' is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by the Free Software 
 * Foundation, either version 3 of the License, or (at your option) any later version.
 *
 * The 'serial communication manager' 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with 'serial communication manager'.  If not, see .
 */

package com.embeddedunveiled.serial.internal;

import java.io.File;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.TreeSet;
import java.util.regex.Pattern;

import com.embeddedunveiled.serial.SerialComManager;

/**
 * Finds all serial ports known to system and return them in sorted alphanumeric order.
 * 
 * @author Rishi Gupta
 */
public final class SerialComPortsList {

	private int osType = -1;
	private SerialComPortJNIBridge mComPortJNIBridge = null;
	private static final Pattern Sol_regExpPattern = Pattern.compile("[0-9]*|[a-z]*");
	private static final String Sol_search_path = "/dev/term/";

	private static final Comparator comparator = new Comparator() {

		@Override
		public int compare(final String valueA, final String valueB) {

			if(valueA.equalsIgnoreCase(valueB)){
				return valueA.compareTo(valueB);
			}

			int al = valueA.length();
			int bl = valueB.length();
			int minLength = (al <= bl) ? al : bl;

			int shiftA = 0;
			int shiftB = 0;

			for(int i = 0; i < minLength; i++){

				char charA = valueA.charAt(i - shiftA);
				char charB = valueB.charAt(i - shiftB);

				if(charA != charB){
					if(Character.isDigit(charA) && Character.isDigit(charB)){

						int[] resultsA = {-1, (i - shiftA)};
						String numVal = "";
						for(int x = (i - shiftA); x < al; x++){
							resultsA[1] = x;
							char c = valueA.charAt(x);
							if(Character.isDigit(c)){
								numVal += c;
							}else {
								break;
							}
						}
						try {
							resultsA[0] = Integer.valueOf(numVal);
						} catch (Exception e) {
							//Do nothing
						}

						int[] resultsB = {-1, (i - shiftB)};
						numVal = "";
						for(int x = (i - shiftB); x < bl; x++){
							resultsB[1] = x;
							char c = valueB.charAt(x);
							if(Character.isDigit(c)){
								numVal += c;
							}else {
								break;
							}
						}
						try {
							resultsB[0] = Integer.valueOf(numVal);
						} catch (Exception e) {
							//Do nothing
						}

						if(resultsA[0] != resultsB[0]){
							return resultsA[0] - resultsB[0];
						}
						if(al < bl){
							i = resultsA[1];
							shiftB = resultsA[1] - resultsB[1];
						}else {
							i = resultsB[1];
							shiftA = resultsB[1] - resultsA[1];
						}
					}else {
						if(Character.toLowerCase(charA) - Character.toLowerCase(charB) != 0){
							return Character.toLowerCase(charA) - Character.toLowerCase(charB);
						}
					}
				}
			}
			return valueA.compareToIgnoreCase(valueB);
		}
	};

	/** Allocates a new SerialComPortsList object. */
	public SerialComPortsList(SerialComPortJNIBridge mComPortJNIBridge, int osType) {
		this.mComPortJNIBridge = mComPortJNIBridge;
		this.osType = osType;
	}

	/**
	 * This methods find all ports known to system at this instant.
	 * For Linux, Windows and Mac OS, ports are found with the help of OS specific facilities/API.
	 * For Solaris, a predefined port naming pattern is matched.
	 * 
	 * @return array of ports found on system or null
	 */
	public String[] listAvailableComPorts() {
		if(osType != SerialComManager.OS_SOLARIS) {  // For Linux, Mac, Windows get list from native library.
			ArrayList portsIdentified = new ArrayList();
			String[] ports = mComPortJNIBridge.listAvailableComPorts();
			if(ports != null) {
				for(String portName : ports){
					portsIdentified.add(portName);
				}
				Collections.sort(portsIdentified, comparator);
				return portsIdentified.toArray(new String[portsIdentified.size()]);
			}
			return null;
		}else {                                           // For Solaris match the pre-known pattern for names.
			String[] portsIdentified = new String[]{};
			File dir = new File(Sol_search_path);
			if(dir.exists() && dir.isDirectory()) {
				File[] nodes = dir.listFiles();
				if(nodes.length > 0) {
					TreeSet portsTree = new TreeSet(comparator);
					for(File file : nodes) {
						String fileName = file.getName();
						if(!file.isDirectory() && !file.isFile() && Sol_regExpPattern.matcher(fileName).find()) {
							portsTree.add(Sol_search_path + fileName);
						}
					}
					portsIdentified = portsTree.toArray(portsIdentified); // return our findings.
				} else {
					return null; // no ports exist
				}
			} else {
				return null; // The look up path directory either does not exist or is not directory.
			}
			return portsIdentified;
		}
	}
}